@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-cart-createCart-doc.txt CHANGED
@@ -29,7 +29,7 @@ undefined
29
29
 
30
30
  # Method Code Examples:
31
31
 
32
- ## Create a cart with minimum required fields
32
+ ## Create a cart with minimum required fields
33
33
 
34
34
  ```javascript
35
35
  /**************************************
@@ -81,95 +81,6 @@ myCreateCartFunction(options)
81
81
  console.error(error);
82
82
  // Handle the error
83
83
  });
84
-
85
- /* Promise resolves to:
86
- *
87
- * {
88
- * "_id": "96a61a4b-6b61-47d1-a039-0213a8230ccd",
89
- * "lineItems": [
90
- * {
91
- * "_id": "00000000-0000-0000-0000-000000000001",
92
- * "quantity": 3,
93
- * "catalogReference": {
94
- * "catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a",
95
- * "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
96
- * },
97
- * "productName": {
98
- * "original": "Shirt",
99
- * "translated": "Shirt"
100
- * },
101
- * "url": "https://example.wixsite.com",
102
- * "price": {
103
- * "amount": "10",
104
- * "convertedAmount": "10",
105
- * "formattedAmount": "€10.00",
106
- * "formattedConvertedAmount": "€10.00"
107
- * },
108
- * "fullPrice": {
109
- * "amount": "10",
110
- * "convertedAmount": "10",
111
- * "formattedAmount": "€10.00",
112
- * "formattedConvertedAmount": "€10.00"
113
- * },
114
- * "priceBeforeDiscounts": {
115
- * "amount": "10",
116
- * "convertedAmount": "10",
117
- * "formattedAmount": "€10.00",
118
- * "formattedConvertedAmount": "€10.00"
119
- * },
120
- * "descriptionLines": [],
121
- * "image": "wix:image://v1/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg#originWidth=1000&originHeight=1000",
122
- * "availability": {
123
- * "status": "AVAILABLE"
124
- * },
125
- * "physicalProperties": {
126
- * "sku": "364115376135191",
127
- * "shippable": true
128
- * },
129
- * "couponScopes": [
130
- * {
131
- * "namespace": "stores",
132
- * "group": {
133
- * "name": "collection",
134
- * "entityId": "00000000-000000-000000-000000000001"
135
- * }
136
- * },
137
- * {
138
- * "namespace": "stores",
139
- * "group": {
140
- * "name": "product",
141
- * "entityId": "c8539b66-7a44-fe18-affc-afec4be8562a"
142
- * }
143
- * }
144
- * ],
145
- * "itemType": {
146
- * "preset": "PHYSICAL"
147
- * },
148
- * "paymentOption": "FULL_PAYMENT_ONLINE"
149
- * }
150
- * ],
151
- * "buyerInfo": {
152
- * "memberId": "c43190d2-eea3-493e-b6e8-f146850c6873"
153
- * },
154
- * "currency": "EUR",
155
- * "conversionCurrency": "EUR",
156
- * "buyerLanguage": "en",
157
- * "siteLanguage": "en",
158
- * "taxIncludedInPrices": false,
159
- * "weightUnit": "KG",
160
- * "subtotal": {
161
- * "amount": "30",
162
- * "convertedAmount": "30",
163
- * "formattedAmount": "€30.00",
164
- * "formattedConvertedAmount": "€30.00"
165
- * },
166
- * "appliedDiscounts": [],
167
- * "inSync": false,
168
- * "_createdDate": "2022-05-16T12:04:01.244Z",
169
- * "_updatedDate": "2022-05-16T12:04:01.244Z"
170
- * }
171
- *
172
- */
173
84
  ```
174
85
 
175
86
 
@@ -179,332 +90,332 @@ myCreateCartFunction(options)
179
90
  Method: ecom.cart.createCart(options)
180
91
  Description: Creates a cart. > **Notes:** > + When adding catalog line items, the `lineItems.catalogReference.appId` and `lineItems.catalogReference.catalogItemId` fields are required. > + This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
181
92
  Method parameters:
182
- param name: options | type: CreateCartOptions | description: Cart creation options.
183
- - name: cartInfo | type: Cart | description: Cart info.
184
- - name: businessLocationId | type: string | description: The business location GUID associated with the cart. To learn more, see the Locations API.
185
- - name: buyerInfo | type: BuyerInfo | description: Buyer information.
186
- - name: contactId | type: string | description: Contact GUID. For more information, see the Contacts API.
187
- - name: email | type: string | description: Buyer email address.
188
- - ONE-OF:
189
- - name: memberId | type: string | description: Member GUID. If the buyer is a site member.
190
- - name: userId | type: string | description: User GUID. If the buyer, or cart owner, is a Wix user.
191
- - name: visitorId | type: string | description: Visitor GUID. If the buyer is **not** a site member.
192
- - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
193
- - name: contactInfo | type: AddressWithContact | description: Contact info.
194
- - name: address | type: Address | description: Address.
195
- - name: addressLine1 | type: string | description: Main address line (usually street name and number).
196
- - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
197
- - name: city | type: string | description: City name.
198
- - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
199
- - name: location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
200
- - name: latitude | type: number | description: Address latitude.
201
- - name: longitude | type: number | description: Address longitude.
202
- - name: postalCode | type: string | description: Postal or zip code.
203
- - name: streetAddress | type: StreetAddress | description: Street address.
204
- - name: name | type: string | description: Street name.
205
- - name: number | type: string | description: Street number.
206
- - 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.
207
- - name: contactDetails | type: FullAddressContactDetails | description: Contact details.
208
- - name: company | type: string | description: Company name.
209
- - name: firstName | type: string | description: First name.
210
- - name: lastName | type: string | description: Last name.
211
- - name: phone | type: string | description: Phone number.
212
- - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
213
- - name: _id | type: string | description: Customer's tax GUID.
214
- - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
215
- enum:
93
+ param name: options | type: CreateCartOptions | description: Cart creation options.
94
+ - name: cartInfo | type: Cart | description: Cart info.
95
+ - name: businessLocationId | type: string | description: The business location GUID associated with the cart. To learn more, see the Locations API.
96
+ - name: buyerInfo | type: BuyerInfo | description: Buyer information.
97
+ - name: contactId | type: string | description: Contact GUID. For more information, see the Contacts API.
98
+ - name: email | type: string | description: Buyer email address.
99
+ - ONE-OF:
100
+ - name: memberId | type: string | description: Member GUID. If the buyer is a site member.
101
+ - name: userId | type: string | description: User GUID. If the buyer, or cart owner, is a Wix user.
102
+ - name: visitorId | type: string | description: Visitor GUID. If the buyer is **not** a site member.
103
+ - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
104
+ - name: contactInfo | type: AddressWithContact | description: Contact info.
105
+ - name: address | type: Address | description: Address.
106
+ - name: addressLine1 | type: string | description: Main address line (usually street name and number).
107
+ - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
108
+ - name: city | type: string | description: City name.
109
+ - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
110
+ - name: location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
111
+ - name: latitude | type: number | description: Address latitude.
112
+ - name: longitude | type: number | description: Address longitude.
113
+ - name: postalCode | type: string | description: Postal or zip code.
114
+ - name: streetAddress | type: StreetAddress | description: Street address.
115
+ - name: name | type: string | description: Street name.
116
+ - name: number | type: string | description: Street number.
117
+ - 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.
118
+ - name: contactDetails | type: FullAddressContactDetails | description: Contact details.
119
+ - name: company | type: string | description: Company name.
120
+ - name: firstName | type: string | description: First name.
121
+ - name: lastName | type: string | description: Last name.
122
+ - name: phone | type: string | description: Phone number.
123
+ - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
124
+ - name: _id | type: string | description: Customer's tax GUID.
125
+ - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
126
+ enum:
216
127
  CNPJ: CNPJ - for corporations
217
128
  CPF: CPF - for individual tax payers.
218
129
  UNSPECIFIED
219
- - name: extendedFields | type: ExtendedFields | description: Fields extended by data extensions
220
- - 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).
221
- - name: overrideCheckoutUrl | type: string | description: `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page. This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
222
- - name: selectedShippingOption | type: SelectedShippingOption | description: Selected shipping option.
223
- - name: carrierId | type: string | description: Carrier GUID.
224
- - name: code | type: string | description: Selected shipping option code. For example, "usps_std_overnight".
225
- - name: couponCode | type: string | description: Code of an existing coupon to apply to cart. For more information, see the Coupons API.
226
- - name: customLineItems | type: Array<CustomLineItem> | description: Custom line items. Custom line items don't trigger the Catalog service plugin. To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
227
- - name: catalogReference | type: CatalogReference | description: Catalog and item reference. Includes 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.
228
- - name: 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"`
229
- - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
230
- - name: 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 a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
231
- - name: deliveryProfileId | type: string | description: Delivery profile GUID.
232
- - name: depositAmount | type: string | description: Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE`. When omitted, the item's price will not be split and is expected to be paid in a single installment.
233
- - name: descriptionLines | type: Array<DescriptionLine> | description: Custom line item description lines. Used for display purposes for the cart, checkout and order.
234
- - name: name | type: DescriptionLineName | description: Description line name.
235
- - 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).
236
- - name: translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
237
- - ONE-OF:
238
- - name: colorInfo | type: Color | description: Description line color value.
239
- - name: code | type: string | description: HEX or RGB color code for display.
240
- - name: 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).
241
- - name: translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
242
- - name: plainText | type: PlainTextValue | description: Description line plain text value.
243
- - name: 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).
244
- - name: translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
245
- - ONE-OF:
246
- - name: fixedQuantity | type: boolean | description: Whether the line item quantity is fixed and cannot be changed. Default: `false`
247
- - name: fullPrice | type: string | description: Item price **before** catalog-defined discount. Defaults to `price` when not provided.
130
+ - name: extendedFields | type: ExtendedFields | description: Fields extended by data extensions
131
+ - 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).
132
+ - name: overrideCheckoutUrl | type: string | description: `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page. This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
133
+ - name: selectedShippingOption | type: SelectedShippingOption | description: Selected shipping option.
134
+ - name: carrierId | type: string | description: Carrier GUID.
135
+ - name: code | type: string | description: Selected shipping option code. For example, "usps_std_overnight".
136
+ - name: couponCode | type: string | description: Code of an existing coupon to apply to cart. For more information, see the Coupons API.
137
+ - name: customLineItems | type: Array<CustomLineItem> | description: Custom line items. Custom line items don't trigger the Catalog service plugin. To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
138
+ - name: catalogReference | type: CatalogReference | description: Catalog and item reference. Includes 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.
139
+ - name: 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"`
140
+ - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
141
+ - name: 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 a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
142
+ - name: deliveryProfileId | type: string | description: Delivery profile GUID.
143
+ - name: depositAmount | type: string | description: Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE`. When omitted, the item's price will not be split and is expected to be paid in a single installment.
144
+ - name: descriptionLines | type: Array<DescriptionLine> | description: Custom line item description lines. Used for display purposes for the cart, checkout and order.
145
+ - name: name | type: DescriptionLineName | description: Description line name.
146
+ - 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).
147
+ - name: translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
148
+ - ONE-OF:
149
+ - name: colorInfo | type: Color | description: Description line color value.
150
+ - name: code | type: string | description: HEX or RGB color code for display.
151
+ - name: 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).
152
+ - name: translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
153
+ - name: plainText | type: PlainTextValue | description: Description line plain text value.
154
+ - name: 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).
155
+ - name: translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
156
+ - ONE-OF:
157
+ - name: fixedQuantity | type: boolean | description: Whether the line item quantity is fixed and cannot be changed. Default: `false`
158
+ - name: fullPrice | type: string | description: Item price **before** catalog-defined discount. Defaults to `price` when not provided.
248
159
  - name: itemType | type: ItemType | description: Item type. Either a preset type or custom. | required: true
249
- - ONE-OF:
250
- - name: custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
251
- - name: preset | type: ItemTypePreset | description: Preset item type.
160
+ - ONE-OF:
161
+ - name: custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
162
+ - name: preset | type: ItemTypePreset | description: Preset item type.
252
163
  enum: DIGITAL, GIFT_CARD, PHYSICAL, SERVICE, UNRECOGNISED
253
- - name: media | type: string | description: Custom line item media. + We only support images coming from Wix media manager, if you want to use an image from another source you must first upload it to [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
254
- - name: membersOnly | type: boolean | description: Whether the item can only be purchased by site members. Default: `false`
255
- - name: modifierGroups | type: Array<V1ModifierGroup> | description: Modifier groups that were added to the item.
256
- - name: _id | type: string | description: Modifier group GUID.
257
- - name: modifiers | type: Array<V1ItemModifier> | description: List of modifiers in this group.
258
- - name: _id | type: string | description: Modifier GUID.
259
- - name: details | type: TranslatableString | description: Additional details.
260
- - name: 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.
261
- - name: translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
262
- - name: label | type: TranslatableString | description: Primary display label for the modifier.
263
- - name: price | type: string | description: The price of the modifier.
264
- - name: quantity | type: number | description: The quantity of this modifier.
265
- - name: name | type: TranslatableString | description: Modifier group name.
266
- - name: paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`. + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout. + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0. + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
267
- enum:
164
+ - name: media | type: string | description: Custom line item media. + We only support images coming from Wix media manager, if you want to use an image from another source you must first upload it to [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
165
+ - name: membersOnly | type: boolean | description: Whether the item can only be purchased by site members. Default: `false`
166
+ - name: modifierGroups | type: Array<V1ModifierGroup> | description: Modifier groups that were added to the item.
167
+ - name: _id | type: string | description: Modifier group GUID.
168
+ - name: modifiers | type: Array<V1ItemModifier> | description: List of modifiers in this group.
169
+ - name: _id | type: string | description: Modifier GUID.
170
+ - name: details | type: TranslatableString | description: Additional details.
171
+ - name: 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.
172
+ - name: translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
173
+ - name: label | type: TranslatableString | description: Primary display label for the modifier.
174
+ - name: price | type: string | description: The price of the modifier.
175
+ - name: quantity | type: number | description: The quantity of this modifier.
176
+ - name: name | type: TranslatableString | description: Modifier group name.
177
+ - name: paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`. + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout. + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0. + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
178
+ enum:
268
179
  DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
269
180
  FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
270
181
  FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
271
182
  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.
272
183
  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`.
273
184
  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.
274
- - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
275
- - name: shippable | type: boolean | description: Whether this line item is shippable.
276
- - name: sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
277
- - name: weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
278
- - name: policies | type: Array<Policy> | description: Policies to be displayed to the customer on the checkout page.
279
- - name: content | type: string | description: Policy content - should be translated
280
- - name: title | type: string | description: Policy title - should be translated
185
+ - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
186
+ - name: shippable | type: boolean | description: Whether this line item is shippable.
187
+ - name: sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
188
+ - name: weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
189
+ - name: policies | type: Array<Policy> | description: Policies to be displayed to the customer on the checkout page.
190
+ - name: content | type: string | description: Policy content - should be translated
191
+ - name: title | type: string | description: Policy title - should be translated
281
192
  - name: price | type: string | description: Custom line item price. Must be a number or a decimal without symbols. | required: true
282
- - name: 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".
283
- - name: 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).
284
- - name: translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
285
- - name: priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false`
193
+ - name: 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".
194
+ - name: 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).
195
+ - name: translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
196
+ - name: priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false`
286
197
  - name: productName | type: ProductName | description: Name of the item or product. | required: true
287
- - 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.
288
- - name: translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
289
- - name: quantity | type: number | description: Custom line item quantity. Min: `1` Max: `100000`
290
- - name: quantityAvailable | type: number | description: Item quantity available for purchase. Only return this if inventory is managed. Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
291
- - name: rootCatalogItemId | type: string | description: In cases where `catalogReference.catalogItemId` is NOT the actual catalog item GUID, this field will return the true item's GUID. + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking GUID. Therefore this value is set to the service GUID. + In most cases, this field is the same as `catalogReference.catalogItemId`. + Used in membership validation.
292
- - name: serviceProperties | type: ServiceProperties | description: Service properties. When relevant, this contains information such as date and number of participants. Used, among other things, when checking for valid memberships.
293
- - name: numberOfParticipants | type: number | description: The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
294
- - name: scheduledDate | type: Date | description: Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. For example, the start time of a class.
295
- - name: taxGroupId | type: string | description: Tax group GUID for this custom line item.
296
- - name: taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
297
- - ONE-OF:
298
- - name: addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
198
+ - 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.
199
+ - name: translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
200
+ - name: quantity | type: number | description: Custom line item quantity. Min: `1` Max: `100000`
201
+ - name: quantityAvailable | type: number | description: Item quantity available for purchase. Only return this if inventory is managed. Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
202
+ - name: rootCatalogItemId | type: string | description: In cases where `catalogReference.catalogItemId` is NOT the actual catalog item GUID, this field will return the true item's GUID. + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking GUID. Therefore this value is set to the service GUID. + In most cases, this field is the same as `catalogReference.catalogItemId`. + Used in membership validation.
203
+ - name: serviceProperties | type: ServiceProperties | description: Service properties. When relevant, this contains information such as date and number of participants. Used, among other things, when checking for valid memberships.
204
+ - name: numberOfParticipants | type: number | description: The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
205
+ - name: scheduledDate | type: Date | description: Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. For example, the start time of a class.
206
+ - name: taxGroupId | type: string | description: Tax group GUID for this custom line item.
207
+ - name: taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
208
+ - ONE-OF:
209
+ - name: addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
299
210
  enum: BILLING, BUSINESS, SHIPPING, UNKNOWN_TAXABLE_ADDRESS
300
- - name: url | type: string | description: URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.
301
- - name: lineItems | type: Array<LineItem> | description: Catalog line items.
302
- - name: catalogOverrideFields | type: CatalogOverrideFields | description: Overriding values for catalog item properties. To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
303
- - name: depositAmount | type: string | description: Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
304
- - name: descriptionLines | type: Array<DescriptionLine> | description: Item description lines. Used when displaying the line item to customers.
305
- - name: fullPrice | type: string | description: Item price **before** discounts.
306
- - name: image | type: string | description: Item image.
307
- - name: paymentOption | type: PaymentOption | description: Payment method selected for the item.
308
- - name: value | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
309
- - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
310
- - name: price | type: string | description: Item price **after** discounts.
311
- - name: productName | type: ProductName | description: Item name.
312
- - name: savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
313
- - name: 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.
314
- - name: 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 using the 'Checkout & Orders - Line Items Schema Plugin' in the app dashboard before they can be accessed with API calls.
315
- - name: quantity | type: number | description: Item quantity.
316
- - name: selectedMembership | type: SelectedMembership | description: Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`.
317
- - name: _id | type: string | description: Membership GUID.
318
- - name: appId | type: string | description: GUID of the app providing this payment option.
319
- - name: taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
211
+ - name: url | type: string | description: URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.
212
+ - name: lineItems | type: Array<LineItem> | description: Catalog line items.
213
+ - name: catalogOverrideFields | type: CatalogOverrideFields | description: Overriding values for catalog item properties. To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
214
+ - name: depositAmount | type: string | description: Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
215
+ - name: descriptionLines | type: Array<DescriptionLine> | description: Item description lines. Used when displaying the line item to customers.
216
+ - name: fullPrice | type: string | description: Item price **before** discounts.
217
+ - name: image | type: string | description: Item image.
218
+ - name: paymentOption | type: PaymentOption | description: Payment method selected for the item.
219
+ - name: value | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
220
+ - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
221
+ - name: price | type: string | description: Item price **after** discounts.
222
+ - name: productName | type: ProductName | description: Item name.
223
+ - name: savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
224
+ - name: 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.
225
+ - name: 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 using the 'Checkout & Orders - Line Items Schema Plugin' in the app dashboard before they can be accessed with API calls.
226
+ - name: quantity | type: number | description: Item quantity.
227
+ - name: selectedMembership | type: SelectedMembership | description: Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`.
228
+ - name: _id | type: string | description: Membership GUID.
229
+ - name: appId | type: string | description: GUID of the app providing this payment option.
230
+ - name: taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
320
231
  Return type: PROMISE<Cart>
321
- - name: _createdDate | type: Date | description: Date and time the cart was created.
322
- - name: _id | type: string | description: Cart GUID.
323
- - name: _updatedDate | type: Date | description: Date and time the cart was updated.
324
- - name: appliedDiscounts | type: Array<CartDiscount> | description: Cart discounts.
325
- - ONE-OF:
326
- - name: appliedDiscounts[].coupon | type: Coupon | description: Coupon details.
327
- - name: appliedDiscounts[].coupon._id | type: string | description: Coupon GUID.
328
- - name: appliedDiscounts[].coupon.code | type: string | description: Coupon code.
329
- - name: appliedDiscounts[].merchantDiscount | type: MerchantDiscount | description: Merchant discount.
330
- - name: appliedDiscounts[].merchantDiscount.amount | type: MultiCurrencyPrice | description: Discount value.
331
- - name: appliedDiscounts[].merchantDiscount.amount.amount | type: string | description: Amount.
332
- - name: appliedDiscounts[].merchantDiscount.amount.convertedAmount | type: string | description: Converted amount.
333
- - name: appliedDiscounts[].merchantDiscount.amount.formattedAmount | type: string | description: Amount formatted with currency symbol.
334
- - name: appliedDiscounts[].merchantDiscount.amount.formattedConvertedAmount | type: string | description: Converted amount formatted with currency symbol.
335
- - name: businessLocationId | type: string | description: The business location GUID associated with the cart. To learn more, see the Locations API.
336
- - name: buyerInfo | type: BuyerInfo | description: Buyer information.
337
- - name: buyerInfo.contactId | type: string | description: Contact GUID. For more information, see the Contacts API.
338
- - name: buyerInfo.email | type: string | description: Buyer email address.
339
- - ONE-OF:
340
- - name: buyerInfo.memberId | type: string | description: Member GUID. If the buyer is a site member.
341
- - name: buyerInfo.userId | type: string | description: User GUID. If the buyer, or cart owner, is a Wix user.
342
- - name: buyerInfo.visitorId | type: string | description: Visitor GUID. If the buyer is **not** a site 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/collecting-and-viewing-buyer-notes) left by the customer.
345
- - name: checkoutId | type: string | description: GUID of the checkout that originated from this cart.
346
- - name: contactInfo | type: AddressWithContact | description: Contact info.
347
- - name: contactInfo.address | type: Address | description: Address.
348
- - name: contactInfo.address.addressLine1 | type: string | description: Main address line (usually street name and number).
349
- - name: contactInfo.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
350
- - name: contactInfo.address.city | type: string | description: City name.
351
- - name: contactInfo.address.country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
352
- - name: contactInfo.address.countryFullname | type: string | description: Country's full name.
353
- - name: contactInfo.address.location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
354
- - name: contactInfo.address.location.latitude | type: number | description: Address latitude.
355
- - name: contactInfo.address.location.longitude | type: number | description: Address longitude.
356
- - name: contactInfo.address.postalCode | type: string | description: Postal or zip code.
357
- - name: contactInfo.address.streetAddress | type: StreetAddress | description: Street address.
358
- - name: contactInfo.address.streetAddress.name | type: string | description: Street name.
359
- - name: contactInfo.address.streetAddress.number | type: string | description: Street number.
360
- - name: contactInfo.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.
361
- - name: contactInfo.address.subdivisionFullname | type: string | description: Subdivision full-name.
362
- - name: contactInfo.contactDetails | type: FullAddressContactDetails | description: Contact details.
363
- - name: contactInfo.contactDetails.company | type: string | description: Company name.
364
- - name: contactInfo.contactDetails.firstName | type: string | description: First name.
365
- - name: contactInfo.contactDetails.lastName | type: string | description: Last name.
366
- - name: contactInfo.contactDetails.phone | type: string | description: Phone number.
367
- - name: contactInfo.contactDetails.vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
368
- - name: contactInfo.contactDetails.vatId._id | type: string | description: Customer's tax GUID.
369
- - name: contactInfo.contactDetails.vatId.type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
370
- enum:
232
+ - name: _createdDate | type: Date | description: Date and time the cart was created.
233
+ - name: _id | type: string | description: Cart GUID.
234
+ - name: _updatedDate | type: Date | description: Date and time the cart was updated.
235
+ - name: appliedDiscounts | type: Array<CartDiscount> | description: Cart discounts.
236
+ - ONE-OF:
237
+ - name: appliedDiscounts[].coupon | type: Coupon | description: Coupon details.
238
+ - name: appliedDiscounts[].coupon._id | type: string | description: Coupon GUID.
239
+ - name: appliedDiscounts[].coupon.code | type: string | description: Coupon code.
240
+ - name: appliedDiscounts[].merchantDiscount | type: MerchantDiscount | description: Merchant discount.
241
+ - name: appliedDiscounts[].merchantDiscount.amount | type: MultiCurrencyPrice | description: Discount value.
242
+ - name: appliedDiscounts[].merchantDiscount.amount.amount | type: string | description: Amount.
243
+ - name: appliedDiscounts[].merchantDiscount.amount.convertedAmount | type: string | description: Converted amount.
244
+ - name: appliedDiscounts[].merchantDiscount.amount.formattedAmount | type: string | description: Amount formatted with currency symbol.
245
+ - name: appliedDiscounts[].merchantDiscount.amount.formattedConvertedAmount | type: string | description: Converted amount formatted with currency symbol.
246
+ - name: businessLocationId | type: string | description: The business location GUID associated with the cart. To learn more, see the Locations API.
247
+ - name: buyerInfo | type: BuyerInfo | description: Buyer information.
248
+ - name: buyerInfo.contactId | type: string | description: Contact GUID. For more information, see the Contacts API.
249
+ - name: buyerInfo.email | type: string | description: Buyer email address.
250
+ - ONE-OF:
251
+ - name: buyerInfo.memberId | type: string | description: Member GUID. If the buyer is a site member.
252
+ - name: buyerInfo.userId | type: string | description: User GUID. If the buyer, or cart owner, is a Wix user.
253
+ - name: buyerInfo.visitorId | type: string | description: Visitor GUID. If the buyer is **not** a site member.
254
+ - 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.
255
+ - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
256
+ - name: checkoutId | type: string | description: GUID of the checkout that originated from this cart.
257
+ - name: contactInfo | type: AddressWithContact | description: Contact info.
258
+ - name: contactInfo.address | type: Address | description: Address.
259
+ - name: contactInfo.address.addressLine1 | type: string | description: Main address line (usually street name and number).
260
+ - name: contactInfo.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
261
+ - name: contactInfo.address.city | type: string | description: City name.
262
+ - name: contactInfo.address.country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
263
+ - name: contactInfo.address.countryFullname | type: string | description: Country's full name.
264
+ - name: contactInfo.address.location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
265
+ - name: contactInfo.address.location.latitude | type: number | description: Address latitude.
266
+ - name: contactInfo.address.location.longitude | type: number | description: Address longitude.
267
+ - name: contactInfo.address.postalCode | type: string | description: Postal or zip code.
268
+ - name: contactInfo.address.streetAddress | type: StreetAddress | description: Street address.
269
+ - name: contactInfo.address.streetAddress.name | type: string | description: Street name.
270
+ - name: contactInfo.address.streetAddress.number | type: string | description: Street number.
271
+ - name: contactInfo.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.
272
+ - name: contactInfo.address.subdivisionFullname | type: string | description: Subdivision full-name.
273
+ - name: contactInfo.contactDetails | type: FullAddressContactDetails | description: Contact details.
274
+ - name: contactInfo.contactDetails.company | type: string | description: Company name.
275
+ - name: contactInfo.contactDetails.firstName | type: string | description: First name.
276
+ - name: contactInfo.contactDetails.lastName | type: string | description: Last name.
277
+ - name: contactInfo.contactDetails.phone | type: string | description: Phone number.
278
+ - name: contactInfo.contactDetails.vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
279
+ - name: contactInfo.contactDetails.vatId._id | type: string | description: Customer's tax GUID.
280
+ - name: contactInfo.contactDetails.vatId.type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
281
+ enum:
371
282
  CNPJ: CNPJ - for corporations
372
283
  CPF: CPF - for individual tax payers.
373
284
  UNSPECIFIED
374
- - name: conversionCurrency | type: string | description: The currency [selected by the customer](https://support.wix.com/en/article/multicurrency-an-overview) during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This reflects the customer’s preferred display currency and may differ from the site’s default currency. When no specific currency is selected by the customer, this matches the `currency` property.
375
- - name: currency | type: string | description: The site’s default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This represents the base currency configured for the site and remains constant regardless of the customer’s currency selection.
376
- - name: extendedFields | type: ExtendedFields | description: Fields extended by data extensions
377
- - name: extendedFields.namespaces | type: Record<string, undefined> | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
378
- - name: lineItems | type: Array<LineItem> | description: Line items.
379
- - name: lineItems[]._id | type: string | description: Line item GUID.
380
- - name: lineItems[].availability | type: ItemAvailabilityInfo | description: Item availability details.
381
- - name: lineItems[].availability.quantityAvailable | type: number | description: Quantity available.
382
- - name: lineItems[].availability.status | type: ItemAvailabilityStatus | description: Item availability status.
285
+ - name: conversionCurrency | type: string | description: The currency [selected by the customer](https://support.wix.com/en/article/multicurrency-an-overview) during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This reflects the customer’s preferred display currency and may differ from the site’s default currency. When no specific currency is selected by the customer, this matches the `currency` property.
286
+ - name: currency | type: string | description: The site’s default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This represents the base currency configured for the site and remains constant regardless of the customer’s currency selection.
287
+ - name: extendedFields | type: ExtendedFields | description: Fields extended by data extensions
288
+ - name: extendedFields.namespaces | type: Record<string, undefined> | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
289
+ - name: lineItems | type: Array<LineItem> | description: Line items.
290
+ - name: lineItems[]._id | type: string | description: Line item GUID.
291
+ - name: lineItems[].availability | type: ItemAvailabilityInfo | description: Item availability details.
292
+ - name: lineItems[].availability.quantityAvailable | type: number | description: Quantity available.
293
+ - name: lineItems[].availability.status | type: ItemAvailabilityStatus | description: Item availability status.
383
294
  enum: AVAILABLE, NOT_AVAILABLE: Item is not in stock.
384
295
  NOT_FOUND: Item does not exist.
385
296
  PARTIALLY_AVAILABLE: Available quantity is less than requested.
386
- - name: lineItems[].catalogOverrideFields | type: CatalogOverrideFields | description: Overriding values for catalog item properties. To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
387
- - name: lineItems[].catalogOverrideFields.depositAmount | type: string | description: Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
388
- - name: lineItems[].catalogOverrideFields.descriptionLines | type: Array<DescriptionLine> | description: Item description lines. Used when displaying the line item to customers.
389
- - name: lineItems[].catalogOverrideFields.descriptionLines[].name | type: DescriptionLineName | description: Description line name.
390
- - name: lineItems[].catalogOverrideFields.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).
391
- - name: lineItems[].catalogOverrideFields.descriptionLines[].name.translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
392
- - ONE-OF:
393
- - name: lineItems[].catalogOverrideFields.descriptionLines[].colorInfo | type: Color | description: Description line color value.
394
- - name: lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.code | type: string | description: HEX or RGB color code for display.
395
- - name: lineItems[].catalogOverrideFields.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).
396
- - name: lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
397
- - name: lineItems[].catalogOverrideFields.descriptionLines[].plainText | type: PlainTextValue | description: Description line plain text value.
398
- - name: lineItems[].catalogOverrideFields.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).
399
- - name: lineItems[].catalogOverrideFields.descriptionLines[].plainText.translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
400
- - ONE-OF:
401
- - name: lineItems[].catalogOverrideFields.fullPrice | type: string | description: Item price **before** discounts.
402
- - name: lineItems[].catalogOverrideFields.image | type: string | description: Item image.
403
- - name: lineItems[].catalogOverrideFields.paymentOption | type: PaymentOption | description: Payment method selected for the item.
404
- - name: lineItems[].catalogOverrideFields.paymentOption.value | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
405
- enum:
297
+ - name: lineItems[].catalogOverrideFields | type: CatalogOverrideFields | description: Overriding values for catalog item properties. To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
298
+ - name: lineItems[].catalogOverrideFields.depositAmount | type: string | description: Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
299
+ - name: lineItems[].catalogOverrideFields.descriptionLines | type: Array<DescriptionLine> | description: Item description lines. Used when displaying the line item to customers.
300
+ - name: lineItems[].catalogOverrideFields.descriptionLines[].name | type: DescriptionLineName | description: Description line name.
301
+ - name: lineItems[].catalogOverrideFields.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).
302
+ - name: lineItems[].catalogOverrideFields.descriptionLines[].name.translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
303
+ - ONE-OF:
304
+ - name: lineItems[].catalogOverrideFields.descriptionLines[].colorInfo | type: Color | description: Description line color value.
305
+ - name: lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.code | type: string | description: HEX or RGB color code for display.
306
+ - name: lineItems[].catalogOverrideFields.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).
307
+ - name: lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
308
+ - name: lineItems[].catalogOverrideFields.descriptionLines[].plainText | type: PlainTextValue | description: Description line plain text value.
309
+ - name: lineItems[].catalogOverrideFields.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).
310
+ - name: lineItems[].catalogOverrideFields.descriptionLines[].plainText.translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
311
+ - ONE-OF:
312
+ - name: lineItems[].catalogOverrideFields.fullPrice | type: string | description: Item price **before** discounts.
313
+ - name: lineItems[].catalogOverrideFields.image | type: string | description: Item image.
314
+ - name: lineItems[].catalogOverrideFields.paymentOption | type: PaymentOption | description: Payment method selected for the item.
315
+ - name: lineItems[].catalogOverrideFields.paymentOption.value | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
316
+ enum:
406
317
  DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
407
318
  FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
408
319
  FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
409
320
  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.
410
321
  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`.
411
322
  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.
412
- - name: lineItems[].catalogOverrideFields.physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
413
- - name: lineItems[].catalogOverrideFields.physicalProperties.shippable | type: boolean | description: Whether this line item is shippable.
414
- - name: lineItems[].catalogOverrideFields.physicalProperties.sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
415
- - name: lineItems[].catalogOverrideFields.physicalProperties.weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
416
- - name: lineItems[].catalogOverrideFields.price | type: string | description: Item price **after** discounts.
417
- - name: lineItems[].catalogOverrideFields.productName | type: ProductName | description: Item name.
418
- - name: lineItems[].catalogOverrideFields.productName.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.
419
- - name: lineItems[].catalogOverrideFields.productName.translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
420
- - name: lineItems[].catalogOverrideFields.savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
421
- - name: lineItems[].catalogReference | type: CatalogReference | description: Catalog and item reference. Holds GUIDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin.
422
- - name: lineItems[].catalogReference.appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). For items from Wix catalogs, the following values always apply: + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
423
- - name: lineItems[].catalogReference.catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
424
- - name: lineItems[].catalogReference.options | type: Record<string, any> | description: Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items. For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
425
- - name: lineItems[].consentRequiredPaymentPolicy | type: string | description: Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
426
- - name: lineItems[].customLineItem | type: boolean | description: Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
427
- - name: lineItems[].deliveryProfileId | type: string | description: Delivery profile GUID.
428
- - name: lineItems[].depositAmount | type: MultiCurrencyPrice | description: Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
429
- - name: lineItems[].descriptionLines | type: Array<DescriptionLine> | description: Line item description lines. Used for displaying the cart, checkout and order.
430
- - name: lineItems[].extendedFields | type: ExtendedFields | description: Custom extended fields for the line item object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured using the 'Checkout & Orders - Line Items Schema Plugin' in the app dashboard before they can be accessed with API calls.
431
- - name: lineItems[].fixedQuantity | type: boolean | description: Whether the line item quantity is fixed and cannot be changed.
432
- - name: lineItems[].fullPrice | type: MultiCurrencyPrice | description: Item price **before** catalog-defined discount. Defaults to `price` when not provided.
433
- - name: lineItems[].image | type: string | description: Line item image details.
434
- - name: lineItems[].itemType | type: ItemType | description: Item type. Either a preset type or custom.
435
- - ONE-OF:
436
- - name: lineItems[].itemType.custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
437
- - name: lineItems[].itemType.preset | type: ItemTypePreset | description: Preset item type.
323
+ - name: lineItems[].catalogOverrideFields.physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
324
+ - name: lineItems[].catalogOverrideFields.physicalProperties.shippable | type: boolean | description: Whether this line item is shippable.
325
+ - name: lineItems[].catalogOverrideFields.physicalProperties.sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
326
+ - name: lineItems[].catalogOverrideFields.physicalProperties.weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
327
+ - name: lineItems[].catalogOverrideFields.price | type: string | description: Item price **after** discounts.
328
+ - name: lineItems[].catalogOverrideFields.productName | type: ProductName | description: Item name.
329
+ - name: lineItems[].catalogOverrideFields.productName.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.
330
+ - name: lineItems[].catalogOverrideFields.productName.translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
331
+ - name: lineItems[].catalogOverrideFields.savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
332
+ - name: lineItems[].catalogReference | type: CatalogReference | description: Catalog and item reference. Holds GUIDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin.
333
+ - name: lineItems[].catalogReference.appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). For items from Wix catalogs, the following values always apply: + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
334
+ - name: lineItems[].catalogReference.catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
335
+ - name: lineItems[].catalogReference.options | type: Record<string, any> | description: Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items. For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
336
+ - name: lineItems[].consentRequiredPaymentPolicy | type: string | description: Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
337
+ - name: lineItems[].customLineItem | type: boolean | description: Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
338
+ - name: lineItems[].deliveryProfileId | type: string | description: Delivery profile GUID.
339
+ - name: lineItems[].depositAmount | type: MultiCurrencyPrice | description: Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
340
+ - name: lineItems[].descriptionLines | type: Array<DescriptionLine> | description: Line item description lines. Used for displaying the cart, checkout and order.
341
+ - name: lineItems[].extendedFields | type: ExtendedFields | description: Custom extended fields for the line item object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured using the 'Checkout & Orders - Line Items Schema Plugin' in the app dashboard before they can be accessed with API calls.
342
+ - name: lineItems[].fixedQuantity | type: boolean | description: Whether the line item quantity is fixed and cannot be changed.
343
+ - name: lineItems[].fullPrice | type: MultiCurrencyPrice | description: Item price **before** catalog-defined discount. Defaults to `price` when not provided.
344
+ - name: lineItems[].image | type: string | description: Line item image details.
345
+ - name: lineItems[].itemType | type: ItemType | description: Item type. Either a preset type or custom.
346
+ - ONE-OF:
347
+ - name: lineItems[].itemType.custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
348
+ - name: lineItems[].itemType.preset | type: ItemTypePreset | description: Preset item type.
438
349
  enum: DIGITAL, GIFT_CARD, PHYSICAL, SERVICE, UNRECOGNISED
439
- - name: lineItems[].lineItemPrice | type: MultiCurrencyPrice | description: Total price **after** catalog-defined discount and line item discounts.
440
- - name: lineItems[].membersOnly | type: boolean | description: Whether the item can only be purchased by site members. Default: `false`
441
- - name: lineItems[].modifierGroups | type: Array<ModifierGroup> | description: Modifier groups that were added to the item.
442
- - name: lineItems[].modifierGroups[]._id | type: string | description: Modifier group GUID.
443
- - name: lineItems[].modifierGroups[].modifiers | type: Array<ItemModifier> | description: List of modifiers in this group.
444
- - name: lineItems[].modifierGroups[].modifiers[]._id | type: string | description: Modifier GUID.
445
- - name: lineItems[].modifierGroups[].modifiers[].details | type: TranslatableString | description: Additional details.
446
- - name: lineItems[].modifierGroups[].modifiers[].details.original | type: string | description: __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). Min: 1 character. Max: 200 characters.
447
- - name: lineItems[].modifierGroups[].modifiers[].details.translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
448
- - name: lineItems[].modifierGroups[].modifiers[].label | type: TranslatableString | description: Primary display label for the modifier.
449
- - name: lineItems[].modifierGroups[].modifiers[].price | type: MultiCurrencyPrice | description: The price of the modifier.
450
- - name: lineItems[].modifierGroups[].modifiers[].quantity | type: number | description: The quantity of this modifier.
451
- - name: lineItems[].modifierGroups[].name | type: TranslatableString | description: Modifier group name.
452
- - name: lineItems[].modifiersTotalPrice | type: MultiCurrencyPrice | description: Total price of all item modifiers. Included in the item price.
453
- - name: lineItems[].paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
454
- - name: lineItems[].physicalProperties | type: PhysicalProperties | description: Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
455
- - name: lineItems[].policies | type: Array<Policy> | description: Policies to be displayed to the customer on the checkout page.
456
- - name: lineItems[].policies[].content | type: string | description: Policy content - should be translated
457
- - name: lineItems[].policies[].title | type: string | description: Policy title - should be translated
458
- - name: lineItems[].price | type: MultiCurrencyPrice | description: Item price **after** catalog-defined discount and line item discounts.
459
- - name: lineItems[].priceBeforeDiscounts | type: MultiCurrencyPrice | description: Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.
460
- - name: lineItems[].priceDescription | type: PriceDescription | description: Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
461
- - name: lineItems[].priceDescription.original | type: string | description: __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
462
- - name: lineItems[].priceDescription.translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
463
- - name: lineItems[].priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created.
464
- - name: lineItems[].productName | type: ProductName | description: Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name`
465
- - name: lineItems[].quantity | type: number | description: Item quantity.
466
- - name: lineItems[].rootCatalogItemId | type: string | description: In cases where `catalogReference.catalogItemId` is NOT the actual catalog item GUID, this field will return the true item's GUID. + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking GUID. Therefore this value is set to the service GUID. + in most cases, this field is the same as `catalogReference.catalogItemId`. + Used in membership validation.
467
- - name: lineItems[].savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
468
- - name: lineItems[].selectedMembership | type: SelectedMembership | description: Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`.
469
- - name: lineItems[].selectedMembership._id | type: string | description: Membership GUID.
470
- - name: lineItems[].selectedMembership.appId | type: string | description: GUID of the app providing this payment option.
471
- - name: lineItems[].serviceProperties | type: ServiceProperties | description: Service properties. When relevant, this contains information such as date and number of participants.
472
- - name: lineItems[].serviceProperties.numberOfParticipants | type: number | description: The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
473
- - name: lineItems[].serviceProperties.scheduledDate | type: Date | description: Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. For example, the start time of a class.
474
- - name: lineItems[].subscriptionOptionInfo | type: SubscriptionOptionInfo | description: Subscription option information.
475
- - name: lineItems[].subscriptionOptionInfo.description | type: Description | description: Subscription option description.
476
- - name: lineItems[].subscriptionOptionInfo.description.original | type: string | description: Subscription option description.
477
- - name: lineItems[].subscriptionOptionInfo.description.translated | type: string | description: Translated subscription option description.
478
- - name: lineItems[].subscriptionOptionInfo.subscriptionSettings | type: SubscriptionSettings | description: Subscription option settings.
479
- - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period.
480
- - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.billingCycles | type: number | description: Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
481
- - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation | type: boolean | description: Whether to allow the customer to cancel the subscription..
482
- - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod | type: FreeTrialPeriod | description: Period until first cycle starts. If applied payNow will be 0 If None => no free trial
483
- - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.frequency | type: SubscriptionFrequency | description: Frequency of period. Values: DAY, WEEK, MONTH, YEAR
350
+ - name: lineItems[].lineItemPrice | type: MultiCurrencyPrice | description: Total price **after** catalog-defined discount and line item discounts.
351
+ - name: lineItems[].membersOnly | type: boolean | description: Whether the item can only be purchased by site members. Default: `false`
352
+ - name: lineItems[].modifierGroups | type: Array<ModifierGroup> | description: Modifier groups that were added to the item.
353
+ - name: lineItems[].modifierGroups[]._id | type: string | description: Modifier group GUID.
354
+ - name: lineItems[].modifierGroups[].modifiers | type: Array<ItemModifier> | description: List of modifiers in this group.
355
+ - name: lineItems[].modifierGroups[].modifiers[]._id | type: string | description: Modifier GUID.
356
+ - name: lineItems[].modifierGroups[].modifiers[].details | type: TranslatableString | description: Additional details.
357
+ - name: lineItems[].modifierGroups[].modifiers[].details.original | type: string | description: __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). Min: 1 character. Max: 200 characters.
358
+ - name: lineItems[].modifierGroups[].modifiers[].details.translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
359
+ - name: lineItems[].modifierGroups[].modifiers[].label | type: TranslatableString | description: Primary display label for the modifier.
360
+ - name: lineItems[].modifierGroups[].modifiers[].price | type: MultiCurrencyPrice | description: The price of the modifier.
361
+ - name: lineItems[].modifierGroups[].modifiers[].quantity | type: number | description: The quantity of this modifier.
362
+ - name: lineItems[].modifierGroups[].name | type: TranslatableString | description: Modifier group name.
363
+ - name: lineItems[].modifiersTotalPrice | type: MultiCurrencyPrice | description: Total price of all item modifiers. Included in the item price.
364
+ - name: lineItems[].paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
365
+ - name: lineItems[].physicalProperties | type: PhysicalProperties | description: Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
366
+ - name: lineItems[].policies | type: Array<Policy> | description: Policies to be displayed to the customer on the checkout page.
367
+ - name: lineItems[].policies[].content | type: string | description: Policy content - should be translated
368
+ - name: lineItems[].policies[].title | type: string | description: Policy title - should be translated
369
+ - name: lineItems[].price | type: MultiCurrencyPrice | description: Item price **after** catalog-defined discount and line item discounts.
370
+ - name: lineItems[].priceBeforeDiscounts | type: MultiCurrencyPrice | description: Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.
371
+ - name: lineItems[].priceDescription | type: PriceDescription | description: Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
372
+ - name: lineItems[].priceDescription.original | type: string | description: __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
373
+ - name: lineItems[].priceDescription.translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
374
+ - name: lineItems[].priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created.
375
+ - name: lineItems[].productName | type: ProductName | description: Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name`
376
+ - name: lineItems[].quantity | type: number | description: Item quantity.
377
+ - name: lineItems[].rootCatalogItemId | type: string | description: In cases where `catalogReference.catalogItemId` is NOT the actual catalog item GUID, this field will return the true item's GUID. + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking GUID. Therefore this value is set to the service GUID. + in most cases, this field is the same as `catalogReference.catalogItemId`. + Used in membership validation.
378
+ - name: lineItems[].savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
379
+ - name: lineItems[].selectedMembership | type: SelectedMembership | description: Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`.
380
+ - name: lineItems[].selectedMembership._id | type: string | description: Membership GUID.
381
+ - name: lineItems[].selectedMembership.appId | type: string | description: GUID of the app providing this payment option.
382
+ - name: lineItems[].serviceProperties | type: ServiceProperties | description: Service properties. When relevant, this contains information such as date and number of participants.
383
+ - name: lineItems[].serviceProperties.numberOfParticipants | type: number | description: The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
384
+ - name: lineItems[].serviceProperties.scheduledDate | type: Date | description: Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. For example, the start time of a class.
385
+ - name: lineItems[].subscriptionOptionInfo | type: SubscriptionOptionInfo | description: Subscription option information.
386
+ - name: lineItems[].subscriptionOptionInfo.description | type: Description | description: Subscription option description.
387
+ - name: lineItems[].subscriptionOptionInfo.description.original | type: string | description: Subscription option description.
388
+ - name: lineItems[].subscriptionOptionInfo.description.translated | type: string | description: Translated subscription option description.
389
+ - name: lineItems[].subscriptionOptionInfo.subscriptionSettings | type: SubscriptionSettings | description: Subscription option settings.
390
+ - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period.
391
+ - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.billingCycles | type: number | description: Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
392
+ - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation | type: boolean | description: Whether to allow the customer to cancel the subscription..
393
+ - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod | type: FreeTrialPeriod | description: Period until first cycle starts. If applied payNow will be 0 If None => no free trial
394
+ - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.frequency | type: SubscriptionFrequency | description: Frequency of period. Values: DAY, WEEK, MONTH, YEAR
484
395
  enum: DAY, MONTH, UNDEFINED, WEEK, YEAR
485
- - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.interval | type: number | description: interval of period
486
- - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.frequency | type: SubscriptionFrequency | description: Frequency of recurring payment.
487
- - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.interval | type: number | description: Interval of recurring payment. Default: `1`. If SubscriptionFrequency is Day the minimum interval is 7
488
- - name: lineItems[].subscriptionOptionInfo.title | type: Title | description: Subscription option title.
489
- - name: lineItems[].subscriptionOptionInfo.title.original | type: string | description: Subscription option 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).
490
- - name: lineItems[].subscriptionOptionInfo.title.translated | type: string | description: Subscription option name translated into the buyer's language. Default: Same as `original`.
491
- - name: lineItems[].taxGroupId | type: string | description: Tax group GUID for this line item.
492
- - name: lineItems[].taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
493
- - ONE-OF:
494
- - name: lineItems[].taxableAddress.addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
396
+ - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.interval | type: number | description: interval of period
397
+ - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.frequency | type: SubscriptionFrequency | description: Frequency of recurring payment.
398
+ - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.interval | type: number | description: Interval of recurring payment. Default: `1`. If SubscriptionFrequency is Day the minimum interval is 7
399
+ - name: lineItems[].subscriptionOptionInfo.title | type: Title | description: Subscription option title.
400
+ - name: lineItems[].subscriptionOptionInfo.title.original | type: string | description: Subscription option 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).
401
+ - name: lineItems[].subscriptionOptionInfo.title.translated | type: string | description: Subscription option name translated into the buyer's language. Default: Same as `original`.
402
+ - name: lineItems[].taxGroupId | type: string | description: Tax group GUID for this line item.
403
+ - name: lineItems[].taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
404
+ - ONE-OF:
405
+ - name: lineItems[].taxableAddress.addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
495
406
  enum: BILLING, BUSINESS, SHIPPING, UNKNOWN_TAXABLE_ADDRESS
496
- - name: lineItems[].url | type: string | description: URL to the item's page on the site.
497
- - name: overrideCheckoutUrl | type: string | description: `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page. This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
498
- - name: paymentCurrency | type: string | description: The currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This is determined by the [customer's selected currency](https://support.wix.com/en/article/multicurrency-an-overview) and the site’s supported payment currencies. If the customer’s selected currency is supported for payment, this matches the `conversionCurrency` property. If not supported, this falls back to the `currency` property.
499
- - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
500
- - name: revision | type: string | description: Revision number, which increments by 1 each time the Cart is updated.
501
- - name: selectedShippingOption | type: SelectedShippingOption | description: Selected shipping option.
502
- - name: selectedShippingOption.carrierId | type: string | description: Carrier GUID.
503
- - name: selectedShippingOption.code | type: string | description: Selected shipping option code. For example, "usps_std_overnight".
504
- - name: siteLanguage | type: string | description: Site language in which original values are displayed.
505
- - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices.
506
- - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit.
507
- enum:
407
+ - name: lineItems[].url | type: string | description: URL to the item's page on the site.
408
+ - name: overrideCheckoutUrl | type: string | description: `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page. This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
409
+ - name: paymentCurrency | type: string | description: The currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This is determined by the [customer's selected currency](https://support.wix.com/en/article/multicurrency-an-overview) and the site’s supported payment currencies. If the customer’s selected currency is supported for payment, this matches the `conversionCurrency` property. If not supported, this falls back to the `currency` property.
410
+ - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
411
+ - name: revision | type: string | description: Revision number, which increments by 1 each time the Cart is updated.
412
+ - name: selectedShippingOption | type: SelectedShippingOption | description: Selected shipping option.
413
+ - name: selectedShippingOption.carrierId | type: string | description: Carrier GUID.
414
+ - name: selectedShippingOption.code | type: string | description: Selected shipping option code. For example, "usps_std_overnight".
415
+ - name: siteLanguage | type: string | description: Site language in which original values are displayed.
416
+ - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices.
417
+ - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit.
418
+ enum:
508
419
  KG: Kilograms.
509
420
  LB: Pounds.
510
421
  UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
@@ -515,4 +426,4 @@ Possible Errors:
515
426
 
516
427
  ```
517
428
  </type_definition>
518
- </ecom_cart_createCart>
429
+ </ecom_cart_createCart>