> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdateOrder # Package: orders # Namespace: Orders # Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/orders/update-order.md ## Permission Scopes: Manage Orders: SCOPE.DC-STORES.MANAGE-ORDERS Manage Orders: SCOPE.DC-STORES.MANAGE-ORDERS ## Introduction Updates an order's properties.
Currently, only the following fields can be updated: + `buyerInfo.email` + `buyerLanguage` + `weightUnit` + `billingInfo.address` + `billingInfo.contactDetails` + `archived` + `attributionSource` + `seenByAHuman` + `recipientInfo.address` + `recipientInfo.contactDetails` + `shippingInfo.logistics.shippingDestination.address` + `shippingInfo.logistics.shippingDestination.contactDetails` + `extendedFields`
To update a field's value, include the new value in the `order` object in the body params. To remove a field's value, pass `null`. > **Notes:** > + Removing `buyerInfo` or `contactDetails` results in an error. > + To modify pricing or line items, use the [Draft Orders API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/introduction.md). To update an order's payment status, use [Update Payment Status](https://dev.wix.com/docs/rest/business-solutions/e-commerce/order-transactions/update-payment-status.md). --- ## REST API ### Schema ``` Method: updateOrder Description: Updates an order's properties.
Currently, only the following fields can be updated: + `buyerInfo.email` + `buyerLanguage` + `weightUnit` + `billingInfo.address` + `billingInfo.contactDetails` + `archived` + `attributionSource` + `seenByAHuman` + `recipientInfo.address` + `recipientInfo.contactDetails` + `shippingInfo.logistics.shippingDestination.address` + `shippingInfo.logistics.shippingDestination.contactDetails` + `extendedFields`
To update a field's value, include the new value in the `order` object in the body params. To remove a field's value, pass `null`. > **Notes:** > + Removing `buyerInfo` or `contactDetails` results in an error. > + To modify pricing or line items, use the [Draft Orders API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/introduction.md). To update an order's payment status, use [Update Payment Status](https://dev.wix.com/docs/rest/business-solutions/e-commerce/order-transactions/update-payment-status.md). URL: https://www.wixapis.com/ecom/v1/orders/{order.id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: order, order Method parameters: param name: order | type: Order | description: An order represents a completed purchase from a buyer. Orders are created through the checkout flow or manually via the Create Order endpoint. The order contains details about purchased items, buyer and recipient information, pricing, tax, shipping, fulfillment status, and payment status. To get the total sum of all discounts applied to an order, use `priceSummary.discount.amount`. | required: true - name: id | type: string | description: Order GUID. | required: true - name: buyerInfo | type: BuyerInfo | description: Buyer information. - ONE-OF: - name: visitorId | type: string | description: Visitor GUID. Returned when the buyer isn't a logged-in site member. - name: memberId | type: string | description: Member GUID. Returned when the buyer is a logged-in site member. - name: contactId | type: string | description: Contact GUID. Automatically created if one doesn't exist. For more information, see [Contacts API](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v4/introduction.md). - name: email | type: string | description: Buyer's email address. - name: paymentStatus | type: PaymentStatus | description: Order payment status. - enum: - UNSPECIFIED: - NOT_PAID: `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`. This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`. - PAID: All required payments associated with this order are paid. - PARTIALLY_REFUNDED: Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details. - FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details. - PENDING: All payments pending. This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly. Learn more about [pending orders](https://support.wix.com/en/article/pending-orders). - PARTIALLY_PAID: At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details. - PENDING_MERCHANT: Payment received, but not yet confirmed by the payment provider. In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner. To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance. - CANCELED: One or more payments canceled. - DECLINED: One or more payments declined. - 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. - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit. - enum: - UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error. - KG: Kilograms. - LB: Pounds. - name: currency | type: string | description: Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. - name: currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites. - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices. - name: billingInfo | type: AddressWithContact | description: Billing address and contact details. - name: address | type: Address | description: Address. - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. - 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. - name: city | type: string | description: City name. - name: postalCode | type: string | description: Postal or zip code. - name: streetAddress | type: StreetAddress | description: Street address. - name: number | type: string | description: Street number. - name: name | type: string | description: Street name. - name: addressLine | type: string | description: Main address line (usually street name and number). - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor. - name: geocode | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates. - name: latitude | type: number | description: Address latitude. - name: longitude | type: number | description: Address longitude. - name: contactDetails | type: FullAddressContactDetails | description: Contact details. - name: firstName | type: string | description: First name. - name: lastName | type: string | description: Last name. - name: phone | type: string | description: Phone number. - name: company | type: string | description: Company name. - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. - name: id | type: string | description: Customer's tax GUID. - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations - enum: - UNSPECIFIED: - CPF: CPF - for individual tax payers. - CNPJ: CNPJ - for corporations - name: shippingInfo | type: ShippingInformation | description: Shipping info and selected shipping option details. - name: carrierId | type: string | description: App Def Id of external provider which was a source of shipping info - name: code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`. - name: title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`. - name: logistics | type: DeliveryLogistics | description: Shipping logistics. - ONE-OF: - name: shippingDestination | type: AddressWithContact | description: Shipping destination address and contact details. For pickup orders, this contains the pickup location address, not the recipient's address. - name: pickupDetails | type: PickupDetails | description: Pickup details for store pickup or pickup point orders. - name: address | type: PickupAddress | description: Pickup address. - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. - 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. - name: city | type: string | description: City name. - name: postalCode | type: string | description: Postal or zip code. - name: streetAddress | type: StreetAddress | description: Street address object, with number, name, and apartment number in separate fields. - name: addressLine | type: string | description: Main address line (usually street name and number). - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor. - name: pickupMethod | type: PickupMethod | description: Pickup method - enum: STORE_PICKUP, PICKUP_POINT - name: deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`. - name: instructions | type: string | description: Instructions for the carrier. For example, `"Please knock on the door. If unanswered, please call contact number."`. - name: deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time slot with start and end times. - name: from | type: string | description: Delivery slot starting time. - name: to | type: string | description: Delivery slot ending time. - name: cost | type: ShippingPrice | description: Shipping costs. - name: price | type: Price | description: Shipping price for display purposes. - name: amount | type: string | description: Amount. - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping. - name: taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`. - name: taxableAmount | type: Price | description: Amount for which tax is calculated. - name: taxRate | type: string | description: Tax rate %, as a decimal point. - name: taxGroupId | type: string | description: Tax group GUID. - name: taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax. - name: taxBreakdown | type: array | description: Tax information for a line item. - name: jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". - name: rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. - name: taxAmount | type: Price | description: Amount of tax calculated for this line item. - name: taxType | type: string | description: The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. This name should be explicit enough to allow the merchant to understand what tax was calculated. - name: jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for. - enum: UNDEFINED, COUNTRY, STATE, COUNTY, CITY, SPECIAL - name: nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price. - name: taxableAmount | type: Price | description: Taxable amount of the line item price. - name: region | type: ShippingRegion | description: Shipping region. - name: name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. - name: status | type: OrderStatus | description: Order status. - enum: - INITIALIZED: Order created, but not yet approved or canceled. - APPROVED: Order approved. This happens when either an online payment is received **or** when `priceSummary.total` is `0` (a zero-total order). Offline orders (cash payment) are automatically approved. - CANCELED: Order canceled by the merchant or buyer. - PENDING: Order is waiting for the buyer to complete checkout. - REJECTED: Order rejected. This happens when pending payments fail. - name: archived | type: boolean | description: Whether order is archived. - name: taxInfo | type: OrderTaxInfo | description: Tax information. - name: totalTax | type: Price | description: Calculated tax, added from line items. - name: taxBreakdown | type: array | description: The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated. - name: taxType | type: string | description: The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. - name: jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies. - name: jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). - name: rate | type: string | description: The rate at which this tax detail was calculated. - name: aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers. - name: appliedDiscounts | type: array | description: Applied discounts. - ONE-OF: - name: coupon | type: Coupon | description: Coupon applied by the customer. - name: id | type: string | description: Coupon GUID. - name: code | type: string | description: Coupon code. - name: name | type: string | description: Coupon name. - name: amount | type: Price | description: Coupon value. - name: merchantDiscount | type: MerchantDiscount | description: Discount applied manually by the merchant. - ONE-OF: - name: discountReason | type: DiscountReason | description: Predefined discount reason. - enum: - UNSPECIFIED: Unknown discount reason. - EXCHANGED_ITEMS: Balance adjustment resulting from an item exchange. - BILLING_ADJUSTMENT: Proportional discount for a shortened subscription billing cycle. Applied when a subscription's billing date is moved earlier, reducing the cycle length. - name: description | type: string | description: Custom discount description as free text. - name: amount | type: Price | description: Discount amount. - name: discountRule | type: DiscountRule | description: Automatic discount applied by the system based on configured discount rules. - name: id | type: string | description: Discount rule GUID - name: name | type: DiscountRuleName | description: Discount rule name - name: original | type: string | description: Original discount rule name (in site's default language). - name: translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided. - name: amount | type: Price | description: Discount value. - name: discountType | type: DiscountType | description: - enum: - GLOBAL: Discount applies to the entire order. - SPECIFIC_ITEMS: Discount applies to specific items. - SHIPPING: Discount applies to shipping. For example, free shipping. - name: id | type: string | description: Discount GUID. - name: lineItemDiscounts | type: array | description: Line items the discount applies to, including the discount amount for each. - name: id | type: string | description: Line item GUID. - name: totalDiscount | type: Price | description: Total discount amount for this line item. - name: attributionSource | type: AttributionSource | description: Order attribution source. - enum: UNSPECIFIED, FACEBOOK_ADS - name: channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order. - name: type | type: ChannelType | description: Sales channel that submitted the order. When creating an order via the API to record an external order, use the channel type that matches the original source. If no matching type exists, use `OTHER_PLATFORM`. - enum: - UNSPECIFIED: Unspecified sales channel. This value is not supported. - WEB: A web client. - POS: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). - EBAY: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). - AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). - OTHER_PLATFORM: Other sales platform. - WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). - WIX_INVOICES: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) - BACKOFFICE_MERCHANT: Wix merchant backoffice. - WISH: Wish sales channel. - CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). - GLOBAL_E: Global-E sales channel. - FACEBOOK: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). - ETSY: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). - TIKTOK: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). - FAIRE_COM: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). - PAYPAL_AGENTIC_CHECKOUT: PayPal Agentic Checkout sales channel. - STRIPE_AGENTIC_CHECKOUT: Stripe Agentic Checkout sales channel. - name: externalOrderId | type: string | description: Reference to an order GUID from an external system. Relevant when recording orders from external platforms. - name: externalOrderUrl | type: string | description: URL to the order in the external system. Relevant when recording orders from external platforms. - name: seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard. - name: checkoutId | type: string | description: Checkout GUID. - name: customFields | type: array | description: Custom fields. - name: value | type: Value | description: Custom field value. - ONE-OF: - name: nullValue | type: | description: - name: numberValue | type: number | description: - name: stringValue | type: string | description: - name: boolValue | type: boolean | description: - name: structValue | type: object | description: - name: listValue | type: ListValue | description: - name: values | type: array | description: - name: title | type: string | description: Custom field title. - name: translatedTitle | type: string | description: Translated custom field title. - name: additionalFees | type: array | description: Additional fees applied to the order. - name: code | type: string | description: Additional fee's unique code for future processing. - name: name | type: string | description: Name of additional fee. - name: price | type: Price | description: Additional fee's price. - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee. - name: providerAppId | type: string | description: SPI implementer's `appId`. - name: priceBeforeTax | type: Price | description: Additional fee's price before tax. - name: priceAfterTax | type: Price | description: Additional fee's price after tax. - name: id | type: string | description: Additional fee's id. - name: lineItemIds | type: array | description: Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order. - name: source | type: AdditionalFeeSource | description: Specifies the entity that added the additional fee. - enum: - SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin. - ITEM: The additional fee was added to the item by a catalog or custom line item. - MANUAL: The additional fee was added manually on request. - SHIPPING: The additional fee was added by the shipping provider. - PLATFORM: The additional fee was added by the Wix eCommerce platform. - name: extendedFields | type: ExtendedFields | description: Custom field data for the order object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | 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.md). - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order. - name: recipientInfo | type: AddressWithContact | description: Final recipient's address and contact details. This field represents who will ultimately receive the order. It may differ from `shippingInfo.logistics.shippingDestination` when: + The chosen shipping option is a pickup point or store pickup, where `shippingDestination` contains the pickup location. + No shipping option is selected. - name: tags | type: Tags | description: Order tags. [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction.md) are labels attached to entities, allowing for flexible categorization and data management. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: purchasedDate | type: string | description: Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Used for migration from external systems. - name: businessLocation | type: Location | description: Order location. - name: id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction.md). - name: platformFeeSummary | type: PlatformFeeSummary | description: Summary of platform fees for this order, including totals by charge type and a breakdown of individual fees. - name: total | type: Price | description: Total sum of all platform fees. - name: totalPassOn | type: Price | description: Total amount of platform fees with `PASS_ON` charge type. - name: totalAbsorbed | type: Price | description: Total amount of platform fees with `ABSORBED` charge type. - name: fees | type: array | description: Specific information about each platform fee. - name: name | type: TranslatableString | description: Platform fee name. - 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.md#request-envelope). Min: 1 character. Max: 200 characters. - name: translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`. - name: amount | type: Price | description: Platform fee amount. - name: lineItemId | type: string | description: GUID of the line item the platform fee applies to. - name: chargeType | type: ChargeType | description: Platform fee charge type. - enum: - PASS_ON: Platform fee passed on to buyer. This type increases the order total, and is visible to the buyer and merchant as an additional fee. - ABSORBED: Platform fee absorbed by merchant. This type does not increase the order total, and is only visible to the merchant. - name: percentageRate | type: string | description: Percentage rate charged as platform fee. The fee rate percentage expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%. Return type: UpdateOrderResponse - name: order | type: Order | description: Newly created order. - name: id | type: string | description: Order GUID. - name: number | type: number | description: Order number displayed in the site owner's dashboard (auto-generated). - name: createdDate | type: string | description: Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. - name: updatedDate | type: string | description: Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. - name: lineItems | type: array | description: Order line items. - name: id | type: string | description: Line item GUID. - name: productName | type: ProductName | description: Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name` - 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.md#request-envelope). Min: 1 character. Max: 200 characters. - name: translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`. - name: catalogReference | type: CatalogReference | description: References to the line item's origin catalog. Empty for custom line items. - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to. - 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"` - name: options | type: object | description: Additional item details in `key:value` pairs. Use this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items. For Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration.md) or [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration.md), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction.md). - name: quantity | type: integer | description: Line item quantity. - name: totalDiscount | type: Price | description: Total discount for this line item's entire quantity. - name: amount | type: string | description: Amount. - name: formattedAmount | type: string | description: Amount formatted with currency symbol. - name: descriptionLines | type: array | description: Line item description lines. Used for display purposes for the cart, checkout and order. - ONE-OF: - name: plainText | type: PlainTextValue | description: Description line plain text value. - 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.md#request-envelope). - name: translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`. - name: colorInfo | type: Color | description: Description line color value. - 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.md#request-envelope). - name: translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`. - name: code | type: string | description: HEX or RGB color code for display. - name: name | type: DescriptionLineName | description: Description line name. - 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.md#request-envelope). - name: translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`. - name: image | type: Image | description: Line item image. - name: id | type: string | description: WixMedia image GUID. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image height. - name: width | type: integer | description: Original image width. - name: altText | type: string | description: Image alt text. - name: filename | type: string | description: Image filename. - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item. When relevant, contains information such as SKU and item weight. - name: weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. - name: sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). - name: shippable | type: boolean | description: Whether this line item is shippable. - name: itemType | type: ItemType | description: Item type. Either a preset type or custom. - ONE-OF: - name: preset | type: ItemTypePreset | description: Preset item type. - enum: UNRECOGNISED, PHYSICAL, DIGITAL, GIFT_CARD, SERVICE - name: custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type. - name: fulfillerId | type: string | description: Fulfiller GUID. Field is empty when the line item is self-fulfilled. To get fulfillment information, pass the order GUID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order.md). - name: refundQuantity | type: integer | description: Number of items that were refunded. - name: restockQuantity | type: integer | description: Number of items restocked. For a per-location breakdown, see `restockLocations`. - name: price | type: Price | description: Line item price after line item discounts for display purposes. - name: priceBeforeDiscounts | type: Price | description: Line item price before line item discounts for display purposes. Defaults to `price` when not provided. - name: totalPriceBeforeTax | type: Price | description: Total price after discounts, and before tax. - name: totalPriceAfterTax | type: Price | description: Total price after all discounts and tax. - name: paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE` - enum: - FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout. - FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. - 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. - DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. - 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`. - 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. - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a specific line item. - name: taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`. - name: taxableAmount | type: Price | description: Amount for which tax is calculated. - name: taxRate | type: string | description: Tax rate %, as a decimal point. - name: taxGroupId | type: string | description: Tax group GUID. - name: taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax. - name: taxBreakdown | type: array | description: Tax information for a line item. - name: jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". - name: rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. - name: taxAmount | type: Price | description: Amount of tax calculated for this line item. - name: taxType | type: string | description: The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. This name should be explicit enough to allow the merchant to understand what tax was calculated. - name: jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for. - enum: UNDEFINED, COUNTRY, STATE, COUNTY, CITY, SPECIAL - name: nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price. - name: taxableAmount | type: Price | description: Taxable amount of the line item price. - name: digitalFile | type: DigitalFile | description: Digital file identifier, relevant only for items with type DIGITAL. - name: fileId | type: string | description: GUID of the secure file in media. - name: link | type: string | description: Link will exist after the digital links have been generated on the order. - name: expirationDate | type: string | description: Link expiration time and date. - name: subscriptionInfo | type: SubscriptionInfo | description: Subscription info. - name: id | type: string | description: Subscription GUID. - name: cycleNumber | type: integer | description: Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. - name: subscriptionSettings | type: SubscriptionSettings | description: Subscription detailed information. - name: frequency | type: SubscriptionFrequency | description: Frequency of recurring payment. - enum: UNDEFINED, DAY, WEEK, MONTH, YEAR - name: interval | type: integer | description: Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months. - name: autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period. - name: billingCycles | type: integer | description: Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. - name: enableCustomerCancellation | type: boolean | description: Whether to allow the customer to cancel the subscription. - name: freeTrialPeriod | type: FreeTrialPeriod | description: Period until first cycle starts. If None => no free trial - name: frequency | type: SubscriptionFrequency | description: Frequency of period. Values: DAY, WEEK, MONTH, YEAR - name: interval | type: integer | description: Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial. - name: chargesDescription | type: string | description: Description of the charges that will be applied for subscription. - 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". - 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.md#request-envelope). - name: translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`. - name: depositAmount | type: Price | description: Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`. - name: locations | type: array | description: Line item locations. The location's total quantity must not exceed the line item quantity. - name: id | type: string | description: Location id in the associated owner app. - name: quantity | type: integer | description: Quantity for specific location. - name: name | type: string | description: Location name. - name: lineItemPrice | type: Price | description: Total price **after** catalog discounts and line item discounts. - name: taxableAddress | type: TaxableAddress | description: Address used for tax calculation. - ONE-OF: - name: addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. - enum: BUSINESS, BILLING, SHIPPING - name: priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false` - 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.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | 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.md). - name: modifierGroups | type: array | description: Modifier groups that were added to the item. - name: id | type: string | description: Modifier group GUID. - name: name | type: TranslatableString | description: Modifier group name. - 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.md#request-envelope). Min: 1 character. Max: 200 characters. - name: translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`. - name: modifiers | type: array | description: List of modifiers in this group. - name: id | type: string | description: Modifier GUID. - name: quantity | type: integer | description: The quantity of this modifier. - name: label | type: TranslatableString | description: Primary display label for the modifier. - name: details | type: TranslatableString | description: Additional details. - name: price | type: Price | description: The price of the modifier. - name: buyerInfo | type: BuyerInfo | description: Buyer information. - ONE-OF: - name: visitorId | type: string | description: Visitor GUID. Returned when the buyer isn't a logged-in site member. - name: memberId | type: string | description: Member GUID. Returned when the buyer is a logged-in site member. - name: contactId | type: string | description: Contact GUID. Automatically created if one doesn't exist. For more information, see [Contacts API](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v4/introduction.md). - name: email | type: string | description: Buyer's email address. - name: paymentStatus | type: PaymentStatus | description: Order payment status. - enum: - UNSPECIFIED: - NOT_PAID: `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`. This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`. - PAID: All required payments associated with this order are paid. - PARTIALLY_REFUNDED: Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details. - FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details. - PENDING: All payments pending. This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly. Learn more about [pending orders](https://support.wix.com/en/article/pending-orders). - PARTIALLY_PAID: At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details. - PENDING_MERCHANT: Payment received, but not yet confirmed by the payment provider. In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner. To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance. - CANCELED: One or more payments canceled. - DECLINED: One or more payments declined. - name: fulfillmentStatus | type: FulfillmentStatus | description: Order fulfillment status. - enum: - NOT_FULFILLED: None of the order items are fulfilled or the order was manually marked as unfulfilled. - FULFILLED: All of the order items are fulfilled or the order was manually marked as fulfilled. Orders without shipping info are fulfilled automatically. - PARTIALLY_FULFILLED: Some, but not all, of the order items are fulfilled. - 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. - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit. - enum: - UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error. - KG: Kilograms. - LB: Pounds. - name: currency | type: string | description: Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. - name: currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites. - name: originalCurrency | type: string | description: Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. This currency is used to calculate the pricing before conversion to the buyer's payment currency. - name: conversionRate | type: string | description: The rate used for converting the original currency to the currency used for payment. - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices. - name: siteLanguage | type: string | description: Site language in which original values are shown. - name: priceSummary | type: PriceSummary | description: Order price summary. - name: subtotal | type: Price | description: Subtotal of all line items, before discounts and before tax. - name: shipping | type: Price | description: Total shipping price, before discounts and before tax. - name: tax | type: Price | description: Total tax applied to the order. - name: discount | type: Price | description: Total discount amount applied to the order. - name: total | type: Price | description: Order's total price after discounts and tax. - name: totalAdditionalFees | type: Price | description: Total additional fees before tax. - name: billingInfo | type: AddressWithContact | description: Billing address and contact details. - name: address | type: Address | description: Address. - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. - 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. - name: city | type: string | description: City name. - name: postalCode | type: string | description: Postal or zip code. - name: streetAddress | type: StreetAddress | description: Street address. - name: number | type: string | description: Street number. - name: name | type: string | description: Street name. - name: addressLine | type: string | description: Main address line (usually street name and number). - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor. - name: geocode | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates. - name: latitude | type: number | description: Address latitude. - name: longitude | type: number | description: Address longitude. - name: countryFullname | type: string | description: Country's full name. - name: subdivisionFullname | type: string | description: Subdivision full-name. - name: contactDetails | type: FullAddressContactDetails | description: Contact details. - name: firstName | type: string | description: First name. - name: lastName | type: string | description: Last name. - name: phone | type: string | description: Phone number. - name: company | type: string | description: Company name. - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. - name: id | type: string | description: Customer's tax GUID. - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations - enum: - UNSPECIFIED: - CPF: CPF - for individual tax payers. - CNPJ: CNPJ - for corporations - name: shippingInfo | type: ShippingInformation | description: Shipping info and selected shipping option details. - name: carrierId | type: string | description: App Def Id of external provider which was a source of shipping info - name: code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`. - name: title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`. - name: logistics | type: DeliveryLogistics | description: Shipping logistics. - ONE-OF: - name: shippingDestination | type: AddressWithContact | description: Shipping destination address and contact details. For pickup orders, this contains the pickup location address, not the recipient's address. - name: pickupDetails | type: PickupDetails | description: Pickup details for store pickup or pickup point orders. - name: address | type: PickupAddress | description: Pickup address. - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. - 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. - name: city | type: string | description: City name. - name: postalCode | type: string | description: Postal or zip code. - name: streetAddress | type: StreetAddress | description: Street address object, with number, name, and apartment number in separate fields. - name: addressLine | type: string | description: Main address line (usually street name and number). - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor. - name: countryFullname | type: string | description: Country's full name. - name: subdivisionFullname | type: string | description: Subdivision full-name. - name: pickupMethod | type: PickupMethod | description: Pickup method - enum: STORE_PICKUP, PICKUP_POINT - name: deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`. - name: instructions | type: string | description: Instructions for the carrier. For example, `"Please knock on the door. If unanswered, please call contact number."`. - name: deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time slot with start and end times. - name: from | type: string | description: Delivery slot starting time. - name: to | type: string | description: Delivery slot ending time. - name: cost | type: ShippingPrice | description: Shipping costs. - name: price | type: Price | description: Shipping price for display purposes. - name: totalPriceBeforeTax | type: Price | description: Total price of shipping after discounts (when relevant), and before tax. - name: totalPriceAfterTax | type: Price | description: Shipping price after all discounts (if any exist), and after tax. - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping. - name: discount | type: Price | description: Shipping discount before tax. - name: region | type: ShippingRegion | description: Shipping region. - name: name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. - name: status | type: OrderStatus | description: Order status. - enum: - INITIALIZED: Order created, but not yet approved or canceled. - APPROVED: Order approved. This happens when either an online payment is received **or** when `priceSummary.total` is `0` (a zero-total order). Offline orders (cash payment) are automatically approved. - CANCELED: Order canceled by the merchant or buyer. - PENDING: Order is waiting for the buyer to complete checkout. - REJECTED: Order rejected. This happens when pending payments fail. - name: archived | type: boolean | description: Whether order is archived. - name: taxInfo | type: OrderTaxInfo | description: Tax information. - name: totalTax | type: Price | description: Calculated tax, added from line items. - name: taxBreakdown | type: array | description: The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated. - name: taxType | type: string | description: The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. - name: jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies. - name: jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). - name: rate | type: string | description: The rate at which this tax detail was calculated. - name: aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers. - name: taxExempt | type: boolean | description: Whether the order is exempt from tax calculations. Default: `false` - name: appliedDiscounts | type: array | description: Applied discounts. - ONE-OF: - name: coupon | type: Coupon | description: Coupon applied by the customer. - name: id | type: string | description: Coupon GUID. - name: code | type: string | description: Coupon code. - name: name | type: string | description: Coupon name. - name: amount | type: Price | description: Coupon value. - name: merchantDiscount | type: MerchantDiscount | description: Discount applied manually by the merchant. - ONE-OF: - name: discountReason | type: DiscountReason | description: Predefined discount reason. - enum: - UNSPECIFIED: Unknown discount reason. - EXCHANGED_ITEMS: Balance adjustment resulting from an item exchange. - BILLING_ADJUSTMENT: Proportional discount for a shortened subscription billing cycle. Applied when a subscription's billing date is moved earlier, reducing the cycle length. - name: description | type: string | description: Custom discount description as free text. - name: amount | type: Price | description: Discount amount. - name: discountRule | type: DiscountRule | description: Automatic discount applied by the system based on configured discount rules. - name: id | type: string | description: Discount rule GUID - name: name | type: DiscountRuleName | description: Discount rule name - name: original | type: string | description: Original discount rule name (in site's default language). - name: translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided. - name: amount | type: Price | description: Discount value. - name: discountType | type: DiscountType | description: - enum: - GLOBAL: Discount applies to the entire order. - SPECIFIC_ITEMS: Discount applies to specific items. - SHIPPING: Discount applies to shipping. For example, free shipping. - name: id | type: string | description: Discount GUID. - name: lineItemDiscounts | type: array | description: Line items the discount applies to, including the discount amount for each. - name: id | type: string | description: Line item GUID. - name: totalDiscount | type: Price | description: Total discount amount for this line item. - name: activities | type: array | description: Order activities. - ONE-OF: - name: merchantComment | type: MerchantComment | description: Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. - name: message | type: string | description: Merchant comment message. - name: orderRefunded | type: OrderRefunded | description: Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. - name: manual | type: boolean | description: Whether order was refunded manually. For example, via payment provider or using cash. - name: amount | type: Price | description: Refund amount. - name: reason | type: string | description: Reason for refund. - name: draftOrderChangesApplied | type: DraftOrderChangesApplied | description: Details of changes made by the Draft Orders API. - name: draftOrderId | type: string | description: Draft order id. - name: reason | type: string | description: Reason for edit, given by user (optional). - name: changes | type: array | description: Changes applied to order. - ONE-OF: - name: lineItemChanged | type: LineItemChanges | description: - name: id | type: string | description: Line item GUID. - name: name | type: ProductName | description: Item name after change. - name: quantity | type: LineItemQuantityChange | description: Item quantity change. - name: originalQuantity | type: integer | description: Item quantity before update. - name: newQuantity | type: integer | description: Item quantity after update. - name: diff | type: integer | description: Difference between original and new quantity. Absolute value. - name: deltaType | type: LineItemQuantityChangeType | description: Type of quantity change: increase or decrease. - enum: - QUANTITY_INCREASED: Quantity increased. - QUANTITY_DECREASED: Quantity decreased. - name: price | type: LineItemPriceChange | description: Item price change. - name: originalPrice | type: Price | description: Item price before update. - name: newPrice | type: Price | description: Item price after update. - name: lineItemAdded | type: ManagedLineItem | description: - name: id | type: string | description: Line item GUID. - name: name | type: ProductName | description: Item name. - name: quantity | type: integer | description: Added or removed item quantity. - name: lineItemRemoved | type: ManagedLineItem | description: - name: discountAdded | type: ManagedDiscount | description: - name: id | type: string | description: Discount id. - name: name | type: TranslatedValue | description: Discount name: coupon name / discount rule name / merchant discount description. - name: original | type: string | description: Value in site default language. - name: translated | type: string | description: Translated value. - name: affectedLineItems | type: array | description: Line items discount applies to. - name: id | type: string | description: Order line item id - name: name | type: ProductName | description: Item name. - name: amount | type: Price | description: Amount associated with this item. (Discount amount for item / additional fee amount for item) - name: totalAmount | type: Price | description: Discount amount. - name: discountRemoved | type: ManagedDiscount | description: - name: additionalFeeAdded | type: ManagedAdditionalFee | description: - name: id | type: string | description: Additional fee id. - name: name | type: TranslatedValue | description: Additional fee name. - name: affectedLineItems | type: array | description: Line items additional fee applies to. - name: totalAmount | type: Price | description: Additional fee amount. - name: additionalFeeRemoved | type: ManagedAdditionalFee | description: - name: totalPriceChanged | type: TotalPriceChange | description: - name: originalTotal | type: Price | description: Order’s total price after discounts and tax. Before update - name: newTotal | type: Price | description: Order’s total price after discounts and tax. After update - name: shippingInformationChanged | type: ShippingInformationChange | description: - name: originalShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. Before update - name: total | type: Price | description: Order’s shipping price. - name: shippingTitle | type: string | description: Order’s shipping title. - name: newShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. After update - name: savedPaymentMethod | type: SavedPaymentMethod | description: Details of the payment method saved for the order. - name: name | type: string | description: Payment method name. - name: description | type: string | description: Payment method description. - name: authorizedPaymentCreated | type: AuthorizedPaymentCreated | description: Details of an authorized payment created. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: amount | type: Price | description: Payment amount. - name: lastFourDigits | type: string | description: The last 4 digits of the card number. - name: brand | type: string | description: Card issuer's brand. - name: authorizedPaymentCaptured | type: AuthorizedPaymentCaptured | description: Details of an authorized payment captured. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: amount | type: Price | description: Payment amount. - name: lastFourDigits | type: string | description: The last 4 digits of the card number. - name: brand | type: string | description: Card issuer's brand. - name: authorizedPaymentVoided | type: AuthorizedPaymentVoided | description: Details of an authorized payment voided. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: amount | type: Price | description: Payment amount. - name: lastFourDigits | type: string | description: The last 4 digits of the card number. - name: brand | type: string | description: Card issuer's brand. - name: refundInitiated | type: RefundInitiated | description: Details of an initiated refund process. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities. - name: refundId | type: string | description: Refund GUID. - name: amount | type: Price | description: Refund amount. - name: payments | type: array | description: Details about the payments being refunded. - ONE-OF: - name: regular | type: RegularPaymentRefund | description: Regular payment refund. - name: amount | type: Price | description: Refund amount. - name: lastFourDigits | type: string | description: The last 4 digits of the card number. - name: brand | type: string | description: Card issuer's brand. - name: giftCard | type: GiftCardPaymentRefund | description: Gift card payment refund. - name: giftCardPaymentId | type: string | description: Gift card payment GUID. - name: amount | type: Price | description: Refund amount. - name: membership | type: MembershipPaymentRefund | description: Membership payment refund. - name: membershipId | type: string | description: Membership GUID. - name: paymentId | type: string | description: Payment GUID. - name: externalRefund | type: boolean | description: Whether refund was made externally and manually on the payment provider's side. - name: reason | type: string | description: Reason for refund. - name: paymentRefunded | type: PaymentRefunded | description: Details of a refunded payment. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities. - name: refundId | type: string | description: Refund GUID. - name: payment | type: RefundedPayment | description: Details about the refunded payment. - name: paymentRefundFailed | type: PaymentRefundFailed | description: Details of a failed payment refund. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities. - name: refundId | type: string | description: Refund GUID. - name: payment | type: RefundedPayment | description: Details about the failed payment refund. - name: refundedAsStoreCredit | type: RefundedAsStoreCredit | description: Details of refund to store credit. - name: amount | type: Price | description: Refund amount. - name: reason | type: string | description: Reason for refund. - name: paymentPending | type: PaymentPending | description: Details of a pending payment. - ONE-OF: - name: regular | type: RegularPayment | description: Regular payment. - ONE-OF: - name: creditCardDetails | type: CreditCardDetails | description: Credit card details. - name: lastFourDigits | type: string | description: The last 4 digits of the card number. - name: brand | type: string | description: Card issuer's brand. - name: amount | type: Price | description: Payment amount. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: paymentCanceled | type: PaymentCanceled | description: Details of a canceled payment. - ONE-OF: - name: regular | type: RegularPayment | description: Regular payment. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: paymentDeclined | type: PaymentDeclined | description: Details of a declined payment. - ONE-OF: - name: regular | type: RegularPayment | description: Regular payment. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: receiptCreated | type: ReceiptCreated | description: Receipt was added for associated payment. - ONE-OF: - name: wixReceipt | type: WixReceipt | description: Receipt created by Wix. - name: receiptId | type: string | description: Receipt GUID. - name: displayNumber | type: string | description: Display number of receipt. - name: externalReceipt | type: ExternalReceipt | description: Receipt created by an external system. - name: receiptId | type: string | description: Receipt GUID. - name: displayNumber | type: string | description: Display number of receipt. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: receiptSent | type: ReceiptSent | description: Receipt sent to customer. - ONE-OF: - name: wixReceipt | type: WixReceipt | description: Receipt created by Wix. - name: externalReceipt | type: ExternalReceipt | description: Receipt created by an external system. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: chargebackCreated | type: ChargebackCreated | description: Order received a chargeback for one of its payments. - name: paymentId | type: string | description: GUID of the payment that received a chargeback. - name: chargebackId | type: string | description: Chargeback GUID. - name: amount | type: Price | description: Chargeback amount. - name: paymentDetails | type: RegularPayment | description: Payment details. - name: chargebackReversed | type: ChargebackReversed | description: Chargeback reversed for one of the order's payments. - name: paymentId | type: string | description: GUID of the payment involved with the chargeback. - name: chargebackId | type: string | description: Chargeback GUID. - name: amount | type: Price | description: Chargeback amount. - name: reversalAmount | type: Price | description: Chargeback reversal amount. - name: paymentDetails | type: RegularPayment | description: Payment details. - name: id | type: string | description: Activity GUID. - name: authorEmail | type: string | description: Activity author's email. - name: createdDate | type: string | description: Activity creation date and time. - name: activityType | type: ActivityType | description: Activity type. - enum: - ORDER_PLACED: New order was created and placed. - ORDER_PAID: Order payment was completed and confirmed. - ORDER_FULFILLED: Order items were marked as fulfilled (shipped or ready for pickup). - ORDER_NOT_FULFILLED: Order fulfillment status was changed to not fulfilled. - ORDER_CANCELED: Order was canceled by merchant or customer. - DOWNLOAD_LINK_SENT: Download link was sent for digital items in the order. - TRACKING_NUMBER_ADDED: Shipping tracking number was added to the order. - TRACKING_NUMBER_EDITED: Existing shipping tracking number was modified. - TRACKING_LINK_ADDED: Tracking link for shipment was added to the order. - SHIPPING_CONFIRMATION_EMAIL_SENT: Email confirming shipment was sent to the customer. - INVOICE_ADDED: Invoice document was added to the order. - INVOICE_REMOVED: Invoice was removed from the order. - INVOICE_SENT: Invoice was sent to the customer via email. - FULFILLER_EMAIL_SENT: Notification email was sent to the order fulfiller. - SHIPPING_ADDRESS_EDITED: Order's shipping address was modified. - EMAIL_EDITED: Order's contact email address was changed. - PICKUP_READY_EMAIL_SENT: Email notification for pickup readiness was sent. - MERCHANT_COMMENT: Comment added to the order by a merchant. - ORDER_PARTIALLY_PAID: Partial payment was received for the order. - DRAFT_ORDER_CHANGES_APPLIED: Changes were applied to a draft order. - SAVED_PAYMENT_METHOD: Payment method was saved for future use. - AUTHORIZED_PAYMENT_CREATED: Payment was authorized but not yet captured. - AUTHORIZED_PAYMENT_CAPTURED: Previously authorized payment was captured. - AUTHORIZED_PAYMENT_VOIDED: Previously authorized payment was voided. - REFUND_INITIATED: Refund process was initiated. - PAYMENT_REFUNDED: Payment was successfully refunded. - PAYMENT_REFUND_FAILED: Attempt to refund payment failed. - REFUNDED_AS_STORE_CREDIT: Refund was issued as store credit. - PAYMENT_PENDING: Payment is awaiting processing or confirmation. - PAYMENT_CANCELED: Payment was canceled before completion. - PAYMENT_DECLINED: Payment was declined by payment provider. - ORDER_PENDING: Order is awaiting approval or processing. - ORDER_REJECTED: Order was rejected by merchant. - RECEIPT_CREATED: Receipt was generated for a payment. - RECEIPT_SENT: Receipt was sent to the customer. - CHARGEBACK_CREATED: Chargeback was created for one of the order's payments. - CHARGEBACK_REVERSED: Chargeback was resolved in merchant's favor. - ORDER_REFUNDED: Order was refunded, either partially or fully. - name: attributionSource | type: AttributionSource | description: Order attribution source. - enum: UNSPECIFIED, FACEBOOK_ADS - name: createdBy | type: CreatedBy | description: GUID of the order's initiator. - ONE-OF: - name: userId | type: string | description: User GUID - when the order was created by a Wix user on behalf of a buyer. For example, via POS (point of service). - name: memberId | type: string | description: Member GUID - when the order was created by a **logged in** site visitor. - name: visitorId | type: string | description: Visitor GUID - when the order was created by a site visitor that was **not** logged in. - name: appId | type: string | description: App GUID - when the order was created by an external application. - name: channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order. - name: type | type: ChannelType | description: Sales channel that submitted the order. When creating an order via the API to record an external order, use the channel type that matches the original source. If no matching type exists, use `OTHER_PLATFORM`. - enum: - UNSPECIFIED: Unspecified sales channel. This value is not supported. - WEB: A web client. - POS: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). - EBAY: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). - AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). - OTHER_PLATFORM: Other sales platform. - WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). - WIX_INVOICES: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) - BACKOFFICE_MERCHANT: Wix merchant backoffice. - WISH: Wish sales channel. - CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). - GLOBAL_E: Global-E sales channel. - FACEBOOK: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). - ETSY: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). - TIKTOK: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). - FAIRE_COM: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). - PAYPAL_AGENTIC_CHECKOUT: PayPal Agentic Checkout sales channel. - STRIPE_AGENTIC_CHECKOUT: Stripe Agentic Checkout sales channel. - name: externalOrderId | type: string | description: Reference to an order GUID from an external system. Relevant when recording orders from external platforms. - name: externalOrderUrl | type: string | description: URL to the order in the external system. Relevant when recording orders from external platforms. - name: seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard. - name: checkoutId | type: string | description: Checkout GUID. - name: customFields | type: array | description: Custom fields. - name: value | type: Value | description: Custom field value. - ONE-OF: - name: nullValue | type: | description: - name: numberValue | type: number | description: - name: stringValue | type: string | description: - name: boolValue | type: boolean | description: - name: structValue | type: object | description: - name: listValue | type: ListValue | description: - name: values | type: array | description: - name: title | type: string | description: Custom field title. - name: translatedTitle | type: string | description: Translated custom field title. - name: balanceSummary | type: BalanceSummary | description: Balance summary. - name: balance | type: Balance | description: Current amount left to pay. - name: amount | type: string | description: Balance amount. A negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made. - name: formattedAmount | type: string | description: Amount formatted with currency symbol. - name: paid | type: Price | description: Sum of all approved and successful payments. The value includes payments that have subsequently been fully or partially refunded. - name: refunded | type: Price | description: Sum of all successfully refunded payments. - name: authorized | type: Price | description: Sum of all authorized payments. - name: pendingRefund | type: Price | description: Sum of all pending refund transactions. - name: pending | type: Price | description: Sum of all pending transactions. - name: chargeback | type: Price | description: Sum of all transaction chargebacks. - name: chargebackReversal | type: Price | description: Sum of all chargeback reversals. - name: platformFees | type: Price | description: Total platform fees actually charged across all payments. This reflects amounts collected, which may differ from the expected fees in `order.platformFeeSummary`. - name: totalMinusPlatformFees | type: Price | description: Order total after deducting platform fees. Represents the net amount payable to the merchant. - name: additionalFees | type: array | description: Additional fees applied to the order. - name: code | type: string | description: Additional fee's unique code for future processing. - name: name | type: string | description: Name of additional fee. - name: price | type: Price | description: Additional fee's price. - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee. - name: providerAppId | type: string | description: SPI implementer's `appId`. - name: priceBeforeTax | type: Price | description: Additional fee's price before tax. - name: priceAfterTax | type: Price | description: Additional fee's price after tax. - name: id | type: string | description: Additional fee's id. - name: lineItemIds | type: array | description: Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order. - name: source | type: AdditionalFeeSource | description: Specifies the entity that added the additional fee. - enum: - SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin. - ITEM: The additional fee was added to the item by a catalog or custom line item. - MANUAL: The additional fee was added manually on request. - SHIPPING: The additional fee was added by the shipping provider. - PLATFORM: The additional fee was added by the Wix eCommerce platform. - name: extendedFields | type: ExtendedFields | description: Custom field data for the order object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls. - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order. - name: recipientInfo | type: AddressWithContact | description: Final recipient's address and contact details. This field represents who will ultimately receive the order. It may differ from `shippingInfo.logistics.shippingDestination` when: + The chosen shipping option is a pickup point or store pickup, where `shippingDestination` contains the pickup location. + No shipping option is selected. - name: tags | type: Tags | description: Order tags. [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction.md) are labels attached to entities, allowing for flexible categorization and data management. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: purchasedDate | type: string | description: Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Used for migration from external systems. - name: businessLocation | type: Location | description: Order location. - name: id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction.md). - name: name | type: string | description: Location name. - name: payAfterFreeTrial | type: PriceSummary | description: Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period. - name: platformFeeSummary | type: PlatformFeeSummary | description: Summary of platform fees for this order, including totals by charge type and a breakdown of individual fees. - name: total | type: Price | description: Total sum of all platform fees. - name: totalPassOn | type: Price | description: Total amount of platform fees with `PASS_ON` charge type. - name: totalAbsorbed | type: Price | description: Total amount of platform fees with `ABSORBED` charge type. - name: fees | type: array | description: Specific information about each platform fee. - name: name | type: TranslatableString | description: Platform fee name. - name: amount | type: Price | description: Platform fee amount. - name: lineItemId | type: string | description: GUID of the line item the platform fee applies to. - name: chargeType | type: ChargeType | description: Platform fee charge type. - enum: - PASS_ON: Platform fee passed on to buyer. This type increases the order total, and is visible to the buyer and merchant as an additional fee. - ABSORBED: Platform fee absorbed by merchant. This type does not increase the order total, and is only visible to the merchant. - name: percentageRate | type: string | description: Percentage rate charged as platform fee. The fee rate percentage expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%. Possible Errors: HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: ORDER_IS_REJECTED | Description: Order can't be updated because its status is `REJECTED`. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: ORDER_IS_PENDING | Description: Order can't be updated because its status is `PENDING`. ``` ### Examples ### Update Order Updates buyer's email. ```curl curl -X PATCH \ 'https://www.wixapis.com/ecom/v1/orders/6da768ad-3c9f-444a-9465-7ae0b89fd305' \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ -d '{ "order": { "buyerInfo": { "email": "a-new-buyerInfo-email@gmail.com" } } }' ``` ### Update Order Updates order shipping address and contact details. ```curl curl -X PATCH \ 'https://www.wixapis.com/ecom/v1/orders/6da768ad-3c9f-444a-9465-7ae0b89fd305' \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ -d '{ "order": { "shippingInfo": { "logistics": { "shippingDestination": { "address": { "country": "GB", "subdivision": "GB-ENG", "city": "London", "postalCode": "N7 6DN", "addressLine": "115 Hornsey Rd", "countryFullname": "United Kingdom", "subdivisionFullname": "England" }, "contactDetails": { "firstName": "Jane", "lastName": "Doe", "phone": "0555555555" } } } } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.orders.Orders.updateOrder(_id, order) Description: Updates an order's properties.
Currently, only the following fields can be updated: + `buyerInfo.email` + `buyerLanguage` + `weightUnit` + `billingInfo.address` + `billingInfo.contactDetails` + `archived` + `attributionSource` + `seenByAHuman` + `recipientInfo.address` + `recipientInfo.contactDetails` + `shippingInfo.logistics.shippingDestination.address` + `shippingInfo.logistics.shippingDestination.contactDetails` + `extendedFields`
To update a field's value, include the new value in the `order` object in the body params. To remove a field's value, pass `null`. > **Notes:** > + Removing `buyerInfo` or `contactDetails` results in an error. > + To modify pricing or line items, use the [Draft Orders API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/introduction.md). To update an order's payment status, use [Update Payment Status](https://dev.wix.com/docs/rest/business-solutions/e-commerce/order-transactions/update-payment-status.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: order, _id Method parameters: param name: _id | type: string | description: Order GUID. | required: true param name: order | type: UpdateOrder | description: An order represents a completed purchase from a buyer. Orders are created through the checkout flow or manually via the Create Order endpoint. The order contains details about purchased items, buyer and recipient information, pricing, tax, shipping, fulfillment status, and payment status. To get the total sum of all discounts applied to an order, use `priceSummary.discount.amount`. | required: true - name: buyerInfo | type: BuyerInfo | description: Buyer information. - ONE-OF: - name: visitorId | type: string | description: Visitor GUID. Returned when the buyer isn't a logged-in site member. - name: memberId | type: string | description: Member GUID. Returned when the buyer is a logged-in site member. - name: contactId | type: string | description: Contact GUID. Automatically created if one doesn't exist. For more information, see [Contacts API](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v4/introduction.md). - name: email | type: string | description: Buyer's email address. - name: paymentStatus | type: PaymentStatus | description: Order payment status. - enum: - UNSPECIFIED: - NOT_PAID: `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`. This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`. - PAID: All required payments associated with this order are paid. - PARTIALLY_REFUNDED: Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details. - FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details. - PENDING: All payments pending. This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly. Learn more about [pending orders](https://support.wix.com/en/article/pending-orders). - PARTIALLY_PAID: At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details. - PENDING_MERCHANT: Payment received, but not yet confirmed by the payment provider. In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner. To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance. - CANCELED: One or more payments canceled. - DECLINED: One or more payments declined. - 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. - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit. - enum: - UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error. - KG: Kilograms. - LB: Pounds. - name: currency | type: string | description: Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. - name: currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites. - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices. - name: billingInfo | type: AddressWithContact | description: Billing address and contact details. - name: address | type: Address | description: Address. - name: streetAddress | type: StreetAddress | description: none - name: name | type: string | description: none - name: number | type: string | description: none - name: city | type: string | description: none - name: subdivision | type: string | description: none - name: country | type: string | description: none - name: postalCode | type: string | description: none - name: addressLine2 | type: string | description: none - name: contactDetails | type: FullAddressContactDetails | description: Contact details. - name: firstName | type: string | description: First name. - name: lastName | type: string | description: Last name. - name: phone | type: string | description: Phone number. - name: company | type: string | description: Company name. - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. - name: _id | type: string | description: Customer's tax GUID. - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations - enum: - UNSPECIFIED: - CPF: CPF - for individual tax payers. - CNPJ: CNPJ - for corporations - name: shippingInfo | type: ShippingInformation | description: Shipping info and selected shipping option details. - name: carrierId | type: string | description: App Def Id of external provider which was a source of shipping info - name: code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`. - name: title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`. - name: logistics | type: DeliveryLogistics | description: Shipping logistics. - ONE-OF: - name: shippingDestination | type: AddressWithContact | description: Shipping destination address and contact details. For pickup orders, this contains the pickup location address, not the recipient's address. - name: pickupDetails | type: PickupDetails | description: Pickup details for store pickup or pickup point orders. - name: address | type: PickupAddress | description: Pickup address. - name: streetAddress | type: StreetAddress | description: none - name: city | type: string | description: none - name: subdivision | type: string | description: none - name: country | type: string | description: none - name: postalCode | type: string | description: none - name: addressLine2 | type: string | description: none - name: pickupMethod | type: PickupMethod | description: Pickup method - enum: STORE_PICKUP, PICKUP_POINT - name: deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`. - name: instructions | type: string | description: Instructions for the carrier. For example, `"Please knock on the door. If unanswered, please call contact number."`. - name: deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time slot with start and end times. - name: from | type: Date | description: Delivery slot starting time. - name: to | type: Date | description: Delivery slot ending time. - name: cost | type: ShippingPrice | description: Shipping costs. - name: price | type: Price | description: Shipping price for display purposes. - name: amount | type: string | description: Amount. - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping. - name: taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`. - name: taxableAmount | type: Price | description: Amount for which tax is calculated. - name: taxRate | type: string | description: Tax rate %, as a decimal point. - name: taxGroupId | type: string | description: Tax group GUID. - name: taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax. - name: taxBreakdown | type: array | description: Tax information for a line item. - name: jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". - name: rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. - name: taxAmount | type: Price | description: Amount of tax calculated for this line item. - name: taxType | type: string | description: The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. This name should be explicit enough to allow the merchant to understand what tax was calculated. - name: jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for. - enum: UNDEFINED, COUNTRY, STATE, COUNTY, CITY, SPECIAL - name: nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price. - name: taxableAmount | type: Price | description: Taxable amount of the line item price. - name: region | type: ShippingRegion | description: Shipping region. - name: name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. - name: status | type: OrderStatus | description: Order status. - enum: - INITIALIZED: Order created, but not yet approved or canceled. - APPROVED: Order approved. This happens when either an online payment is received **or** when `priceSummary.total` is `0` (a zero-total order). Offline orders (cash payment) are automatically approved. - CANCELED: Order canceled by the merchant or buyer. - PENDING: Order is waiting for the buyer to complete checkout. - REJECTED: Order rejected. This happens when pending payments fail. - name: archived | type: boolean | description: Whether order is archived. - name: taxInfo | type: OrderTaxInfo | description: Tax information. - name: totalTax | type: Price | description: Calculated tax, added from line items. - name: taxBreakdown | type: array | description: The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated. - name: taxType | type: string | description: The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. - name: jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies. - name: jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). - name: rate | type: string | description: The rate at which this tax detail was calculated. - name: aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers. - name: appliedDiscounts | type: array | description: Applied discounts. - ONE-OF: - name: coupon | type: Coupon | description: Coupon applied by the customer. - name: _id | type: string | description: Coupon GUID. - name: code | type: string | description: Coupon code. - name: name | type: string | description: Coupon name. - name: amount | type: Price | description: Coupon value. - name: merchantDiscount | type: MerchantDiscount | description: Discount applied manually by the merchant. - ONE-OF: - name: discountReason | type: DiscountReason | description: Predefined discount reason. - enum: - UNSPECIFIED: Unknown discount reason. - EXCHANGED_ITEMS: Balance adjustment resulting from an item exchange. - BILLING_ADJUSTMENT: Proportional discount for a shortened subscription billing cycle. Applied when a subscription's billing date is moved earlier, reducing the cycle length. - name: description | type: string | description: Custom discount description as free text. - name: amount | type: Price | description: Discount amount. - name: discountRule | type: DiscountRule | description: Automatic discount applied by the system based on configured discount rules. - name: _id | type: string | description: Discount rule GUID - name: name | type: DiscountRuleName | description: Discount rule name - name: original | type: string | description: Original discount rule name (in site's default language). - name: translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided. - name: amount | type: Price | description: Discount value. - name: discountType | type: DiscountType | description: - enum: - GLOBAL: Discount applies to the entire order. - SPECIFIC_ITEMS: Discount applies to specific items. - SHIPPING: Discount applies to shipping. For example, free shipping. - name: _id | type: string | description: Discount GUID. - name: lineItemDiscounts | type: array | description: Line items the discount applies to, including the discount amount for each. - name: _id | type: string | description: Line item GUID. - name: totalDiscount | type: Price | description: Total discount amount for this line item. - name: attributionSource | type: AttributionSource | description: Order attribution source. - enum: UNSPECIFIED, FACEBOOK_ADS - name: channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order. - name: type | type: ChannelType | description: Sales channel that submitted the order. When creating an order via the API to record an external order, use the channel type that matches the original source. If no matching type exists, use `OTHER_PLATFORM`. - enum: - UNSPECIFIED: Unspecified sales channel. This value is not supported. - WEB: A web client. - POS: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). - EBAY: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). - AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). - OTHER_PLATFORM: Other sales platform. - WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). - WIX_INVOICES: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) - BACKOFFICE_MERCHANT: Wix merchant backoffice. - WISH: Wish sales channel. - CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). - GLOBAL_E: Global-E sales channel. - FACEBOOK: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). - ETSY: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). - TIKTOK: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). - FAIRE_COM: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). - PAYPAL_AGENTIC_CHECKOUT: PayPal Agentic Checkout sales channel. - STRIPE_AGENTIC_CHECKOUT: Stripe Agentic Checkout sales channel. - name: externalOrderId | type: string | description: Reference to an order GUID from an external system. Relevant when recording orders from external platforms. - name: externalOrderUrl | type: string | description: URL to the order in the external system. Relevant when recording orders from external platforms. - name: seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard. - name: checkoutId | type: string | description: Checkout GUID. - name: customFields | type: array | description: Custom fields. - name: value | type: Value | description: Custom field value. - ONE-OF: - name: nullValue | type: | description: - name: numberValue | type: number | description: - name: stringValue | type: string | description: - name: boolValue | type: boolean | description: - name: structValue | type: object | description: - name: listValue | type: ListValue | description: - name: values | type: array | description: - name: title | type: string | description: Custom field title. - name: translatedTitle | type: string | description: Translated custom field title. - name: additionalFees | type: array | description: Additional fees applied to the order. - name: code | type: string | description: Additional fee's unique code for future processing. - name: name | type: string | description: Name of additional fee. - name: price | type: Price | description: Additional fee's price. - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee. - name: providerAppId | type: string | description: SPI implementer's `appId`. - name: priceBeforeTax | type: Price | description: Additional fee's price before tax. - name: priceAfterTax | type: Price | description: Additional fee's price after tax. - name: _id | type: string | description: Additional fee's id. - name: lineItemIds | type: array | description: Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order. - name: source | type: AdditionalFeeSource | description: Specifies the entity that added the additional fee. - enum: - SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin. - ITEM: The additional fee was added to the item by a catalog or custom line item. - MANUAL: The additional fee was added manually on request. - SHIPPING: The additional fee was added by the shipping provider. - PLATFORM: The additional fee was added by the Wix eCommerce platform. - name: extendedFields | type: ExtendedFields | description: Custom field data for the order object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | 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.md). - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order. - name: recipientInfo | type: AddressWithContact | description: Final recipient's address and contact details. This field represents who will ultimately receive the order. It may differ from `shippingInfo.logistics.shippingDestination` when: + The chosen shipping option is a pickup point or store pickup, where `shippingDestination` contains the pickup location. + No shipping option is selected. - name: tags | type: Tags | description: Order tags. [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction.md) are labels attached to entities, allowing for flexible categorization and data management. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: purchasedDate | type: Date | description: Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Used for migration from external systems. - name: businessLocation | type: Location | description: Order location. - name: _id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction.md). - name: platformFeeSummary | type: PlatformFeeSummary | description: Summary of platform fees for this order, including totals by charge type and a breakdown of individual fees. - name: total | type: Price | description: Total sum of all platform fees. - name: totalPassOn | type: Price | description: Total amount of platform fees with `PASS_ON` charge type. - name: totalAbsorbed | type: Price | description: Total amount of platform fees with `ABSORBED` charge type. - name: fees | type: array | description: Specific information about each platform fee. - name: name | type: TranslatableString | description: Platform fee name. - 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.md#request-envelope). Min: 1 character. Max: 200 characters. - name: translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`. - name: amount | type: Price | description: Platform fee amount. - name: lineItemId | type: string | description: GUID of the line item the platform fee applies to. - name: chargeType | type: ChargeType | description: Platform fee charge type. - enum: - PASS_ON: Platform fee passed on to buyer. This type increases the order total, and is visible to the buyer and merchant as an additional fee. - ABSORBED: Platform fee absorbed by merchant. This type does not increase the order total, and is only visible to the merchant. - name: percentageRate | type: string | description: Percentage rate charged as platform fee. The fee rate percentage expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%. Return type: PROMISE - name: _id | type: string | description: Order GUID. - name: number | type: number | description: Order number displayed in the site owner's dashboard (auto-generated). - name: _createdDate | type: Date | description: Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. - name: _updatedDate | type: Date | description: Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. - name: lineItems | type: array | description: Order line items. - name: _id | type: string | description: Line item GUID. - name: productName | type: ProductName | description: Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name` - 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.md#request-envelope). Min: 1 character. Max: 200 characters. - name: translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`. - name: catalogReference | type: CatalogReference | description: References to the line item's origin catalog. Empty for custom line items. - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to. - 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"` - name: options | type: object | description: Additional item details in `key:value` pairs. Use this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items. For Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration.md) or [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration.md), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction.md). - name: quantity | type: integer | description: Line item quantity. - name: totalDiscount | type: Price | description: Total discount for this line item's entire quantity. - name: amount | type: string | description: Amount. - name: formattedAmount | type: string | description: Amount formatted with currency symbol. - name: descriptionLines | type: array | description: Line item description lines. Used for display purposes for the cart, checkout and order. - ONE-OF: - name: plainText | type: PlainTextValue | description: Description line plain text value. - 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.md#request-envelope). - name: translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`. - name: colorInfo | type: Color | description: Description line color value. - 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.md#request-envelope). - name: translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`. - name: code | type: string | description: HEX or RGB color code for display. - name: name | type: DescriptionLineName | description: Description line name. - 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.md#request-envelope). - name: translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`. - name: image | type: string | description: Line item image. - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item. When relevant, contains information such as SKU and item weight. - name: weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. - name: sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). - name: shippable | type: boolean | description: Whether this line item is shippable. - name: itemType | type: ItemType | description: Item type. Either a preset type or custom. - ONE-OF: - name: preset | type: ItemTypePreset | description: Preset item type. - enum: UNRECOGNISED, PHYSICAL, DIGITAL, GIFT_CARD, SERVICE - name: custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type. - name: fulfillerId | type: string | description: Fulfiller GUID. Field is empty when the line item is self-fulfilled. To get fulfillment information, pass the order GUID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order.md). - name: refundQuantity | type: integer | description: Number of items that were refunded. - name: restockQuantity | type: integer | description: Number of items restocked. For a per-location breakdown, see `restockLocations`. - name: price | type: Price | description: Line item price after line item discounts for display purposes. - name: priceBeforeDiscounts | type: Price | description: Line item price before line item discounts for display purposes. Defaults to `price` when not provided. - name: totalPriceBeforeTax | type: Price | description: Total price after discounts, and before tax. - name: totalPriceAfterTax | type: Price | description: Total price after all discounts and tax. - name: paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE` - enum: - FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout. - FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. - 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. - DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. - 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`. - 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. - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a specific line item. - name: taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`. - name: taxableAmount | type: Price | description: Amount for which tax is calculated. - name: taxRate | type: string | description: Tax rate %, as a decimal point. - name: taxGroupId | type: string | description: Tax group GUID. - name: taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax. - name: taxBreakdown | type: array | description: Tax information for a line item. - name: jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". - name: rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. - name: taxAmount | type: Price | description: Amount of tax calculated for this line item. - name: taxType | type: string | description: The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. This name should be explicit enough to allow the merchant to understand what tax was calculated. - name: jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for. - enum: UNDEFINED, COUNTRY, STATE, COUNTY, CITY, SPECIAL - name: nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price. - name: taxableAmount | type: Price | description: Taxable amount of the line item price. - name: digitalFile | type: DigitalFile | description: Digital file identifier, relevant only for items with type DIGITAL. - name: fileId | type: string | description: GUID of the secure file in media. - name: link | type: string | description: Link will exist after the digital links have been generated on the order. - name: expirationDate | type: Date | description: Link expiration time and date. - name: subscriptionInfo | type: SubscriptionInfo | description: Subscription info. - name: _id | type: string | description: Subscription GUID. - name: cycleNumber | type: integer | description: Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. - name: subscriptionSettings | type: SubscriptionSettings | description: Subscription detailed information. - name: frequency | type: SubscriptionFrequency | description: Frequency of recurring payment. - enum: UNDEFINED, DAY, WEEK, MONTH, YEAR - name: interval | type: integer | description: Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months. - name: autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period. - name: billingCycles | type: integer | description: Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. - name: enableCustomerCancellation | type: boolean | description: Whether to allow the customer to cancel the subscription. - name: freeTrialPeriod | type: FreeTrialPeriod | description: Period until first cycle starts. If None => no free trial - name: frequency | type: SubscriptionFrequency | description: Frequency of period. Values: DAY, WEEK, MONTH, YEAR - name: interval | type: integer | description: Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial. - name: chargesDescription | type: string | description: Description of the charges that will be applied for subscription. - 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". - 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.md#request-envelope). - name: translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`. - name: depositAmount | type: Price | description: Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`. - name: locations | type: array | description: Line item locations. The location's total quantity must not exceed the line item quantity. - name: _id | type: string | description: Location id in the associated owner app. - name: quantity | type: integer | description: Quantity for specific location. - name: name | type: string | description: Location name. - name: lineItemPrice | type: Price | description: Total price **after** catalog discounts and line item discounts. - name: taxableAddress | type: TaxableAddress | description: Address used for tax calculation. - ONE-OF: - name: addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. - enum: BUSINESS, BILLING, SHIPPING - name: priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false` - 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.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | 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.md). - name: modifierGroups | type: array | description: Modifier groups that were added to the item. - name: _id | type: string | description: Modifier group GUID. - name: name | type: TranslatableString | description: Modifier group name. - 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.md#request-envelope). Min: 1 character. Max: 200 characters. - name: translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`. - name: modifiers | type: array | description: List of modifiers in this group. - name: _id | type: string | description: Modifier GUID. - name: quantity | type: integer | description: The quantity of this modifier. - name: label | type: TranslatableString | description: Primary display label for the modifier. - name: details | type: TranslatableString | description: Additional details. - name: price | type: Price | description: The price of the modifier. - name: buyerInfo | type: BuyerInfo | description: Buyer information. - ONE-OF: - name: visitorId | type: string | description: Visitor GUID. Returned when the buyer isn't a logged-in site member. - name: memberId | type: string | description: Member GUID. Returned when the buyer is a logged-in site member. - name: contactId | type: string | description: Contact GUID. Automatically created if one doesn't exist. For more information, see [Contacts API](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v4/introduction.md). - name: email | type: string | description: Buyer's email address. - name: paymentStatus | type: PaymentStatus | description: Order payment status. - enum: - UNSPECIFIED: - NOT_PAID: `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`. This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`. - PAID: All required payments associated with this order are paid. - PARTIALLY_REFUNDED: Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details. - FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details. - PENDING: All payments pending. This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly. Learn more about [pending orders](https://support.wix.com/en/article/pending-orders). - PARTIALLY_PAID: At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details. - PENDING_MERCHANT: Payment received, but not yet confirmed by the payment provider. In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner. To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance. - CANCELED: One or more payments canceled. - DECLINED: One or more payments declined. - name: fulfillmentStatus | type: FulfillmentStatus | description: Order fulfillment status. - enum: - NOT_FULFILLED: None of the order items are fulfilled or the order was manually marked as unfulfilled. - FULFILLED: All of the order items are fulfilled or the order was manually marked as fulfilled. Orders without shipping info are fulfilled automatically. - PARTIALLY_FULFILLED: Some, but not all, of the order items are fulfilled. - 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. - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit. - enum: - UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error. - KG: Kilograms. - LB: Pounds. - name: currency | type: string | description: Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. - name: currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites. - name: originalCurrency | type: string | description: Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. This currency is used to calculate the pricing before conversion to the buyer's payment currency. - name: conversionRate | type: string | description: The rate used for converting the original currency to the currency used for payment. - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices. - name: siteLanguage | type: string | description: Site language in which original values are shown. - name: priceSummary | type: PriceSummary | description: Order price summary. - name: subtotal | type: Price | description: Subtotal of all line items, before discounts and before tax. - name: shipping | type: Price | description: Total shipping price, before discounts and before tax. - name: tax | type: Price | description: Total tax applied to the order. - name: discount | type: Price | description: Total discount amount applied to the order. - name: total | type: Price | description: Order's total price after discounts and tax. - name: totalAdditionalFees | type: Price | description: Total additional fees before tax. - name: billingInfo | type: AddressWithContact | description: Billing address and contact details. - name: address | type: Address | description: Address. - name: streetAddress | type: StreetAddress | description: none - name: name | type: string | description: none - name: number | type: string | description: none - name: city | type: string | description: none - name: subdivision | type: string | description: none - name: country | type: string | description: none - name: postalCode | type: string | description: none - name: addressLine2 | type: string | description: none - name: contactDetails | type: FullAddressContactDetails | description: Contact details. - name: firstName | type: string | description: First name. - name: lastName | type: string | description: Last name. - name: phone | type: string | description: Phone number. - name: company | type: string | description: Company name. - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. - name: _id | type: string | description: Customer's tax GUID. - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations - enum: - UNSPECIFIED: - CPF: CPF - for individual tax payers. - CNPJ: CNPJ - for corporations - name: shippingInfo | type: ShippingInformation | description: Shipping info and selected shipping option details. - name: carrierId | type: string | description: App Def Id of external provider which was a source of shipping info - name: code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`. - name: title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`. - name: logistics | type: DeliveryLogistics | description: Shipping logistics. - ONE-OF: - name: shippingDestination | type: AddressWithContact | description: Shipping destination address and contact details. For pickup orders, this contains the pickup location address, not the recipient's address. - name: pickupDetails | type: PickupDetails | description: Pickup details for store pickup or pickup point orders. - name: address | type: PickupAddress | description: Pickup address. - name: streetAddress | type: StreetAddress | description: none - name: city | type: string | description: none - name: subdivision | type: string | description: none - name: country | type: string | description: none - name: postalCode | type: string | description: none - name: addressLine2 | type: string | description: none - name: pickupMethod | type: PickupMethod | description: Pickup method - enum: STORE_PICKUP, PICKUP_POINT - name: deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`. - name: instructions | type: string | description: Instructions for the carrier. For example, `"Please knock on the door. If unanswered, please call contact number."`. - name: deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time slot with start and end times. - name: from | type: Date | description: Delivery slot starting time. - name: to | type: Date | description: Delivery slot ending time. - name: cost | type: ShippingPrice | description: Shipping costs. - name: price | type: Price | description: Shipping price for display purposes. - name: totalPriceBeforeTax | type: Price | description: Total price of shipping after discounts (when relevant), and before tax. - name: totalPriceAfterTax | type: Price | description: Shipping price after all discounts (if any exist), and after tax. - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping. - name: discount | type: Price | description: Shipping discount before tax. - name: region | type: ShippingRegion | description: Shipping region. - name: name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. - name: status | type: OrderStatus | description: Order status. - enum: - INITIALIZED: Order created, but not yet approved or canceled. - APPROVED: Order approved. This happens when either an online payment is received **or** when `priceSummary.total` is `0` (a zero-total order). Offline orders (cash payment) are automatically approved. - CANCELED: Order canceled by the merchant or buyer. - PENDING: Order is waiting for the buyer to complete checkout. - REJECTED: Order rejected. This happens when pending payments fail. - name: archived | type: boolean | description: Whether order is archived. - name: taxInfo | type: OrderTaxInfo | description: Tax information. - name: totalTax | type: Price | description: Calculated tax, added from line items. - name: taxBreakdown | type: array | description: The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated. - name: taxType | type: string | description: The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. - name: jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies. - name: jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). - name: rate | type: string | description: The rate at which this tax detail was calculated. - name: aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers. - name: taxExempt | type: boolean | description: Whether the order is exempt from tax calculations. Default: `false` - name: appliedDiscounts | type: array | description: Applied discounts. - ONE-OF: - name: coupon | type: Coupon | description: Coupon applied by the customer. - name: _id | type: string | description: Coupon GUID. - name: code | type: string | description: Coupon code. - name: name | type: string | description: Coupon name. - name: amount | type: Price | description: Coupon value. - name: merchantDiscount | type: MerchantDiscount | description: Discount applied manually by the merchant. - ONE-OF: - name: discountReason | type: DiscountReason | description: Predefined discount reason. - enum: - UNSPECIFIED: Unknown discount reason. - EXCHANGED_ITEMS: Balance adjustment resulting from an item exchange. - BILLING_ADJUSTMENT: Proportional discount for a shortened subscription billing cycle. Applied when a subscription's billing date is moved earlier, reducing the cycle length. - name: description | type: string | description: Custom discount description as free text. - name: amount | type: Price | description: Discount amount. - name: discountRule | type: DiscountRule | description: Automatic discount applied by the system based on configured discount rules. - name: _id | type: string | description: Discount rule GUID - name: name | type: DiscountRuleName | description: Discount rule name - name: original | type: string | description: Original discount rule name (in site's default language). - name: translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided. - name: amount | type: Price | description: Discount value. - name: discountType | type: DiscountType | description: - enum: - GLOBAL: Discount applies to the entire order. - SPECIFIC_ITEMS: Discount applies to specific items. - SHIPPING: Discount applies to shipping. For example, free shipping. - name: _id | type: string | description: Discount GUID. - name: lineItemDiscounts | type: array | description: Line items the discount applies to, including the discount amount for each. - name: _id | type: string | description: Line item GUID. - name: totalDiscount | type: Price | description: Total discount amount for this line item. - name: activities | type: array | description: Order activities. - ONE-OF: - name: merchantComment | type: MerchantComment | description: Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. - name: message | type: string | description: Merchant comment message. - name: orderRefunded | type: OrderRefunded | description: Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. - name: manual | type: boolean | description: Whether order was refunded manually. For example, via payment provider or using cash. - name: amount | type: Price | description: Refund amount. - name: reason | type: string | description: Reason for refund. - name: draftOrderChangesApplied | type: DraftOrderChangesApplied | description: Details of changes made by the Draft Orders API. - name: draftOrderId | type: string | description: Draft order id. - name: reason | type: string | description: Reason for edit, given by user (optional). - name: changes | type: array | description: Changes applied to order. - ONE-OF: - name: lineItemChanged | type: LineItemChanges | description: - name: _id | type: string | description: Line item GUID. - name: name | type: ProductName | description: Item name after change. - name: quantity | type: LineItemQuantityChange | description: Item quantity change. - name: originalQuantity | type: integer | description: Item quantity before update. - name: newQuantity | type: integer | description: Item quantity after update. - name: diff | type: integer | description: Difference between original and new quantity. Absolute value. - name: deltaType | type: LineItemQuantityChangeType | description: Type of quantity change: increase or decrease. - enum: - QUANTITY_INCREASED: Quantity increased. - QUANTITY_DECREASED: Quantity decreased. - name: price | type: LineItemPriceChange | description: Item price change. - name: originalPrice | type: Price | description: Item price before update. - name: newPrice | type: Price | description: Item price after update. - name: lineItemAdded | type: ManagedLineItem | description: - name: _id | type: string | description: Line item GUID. - name: name | type: ProductName | description: Item name. - name: quantity | type: integer | description: Added or removed item quantity. - name: lineItemRemoved | type: ManagedLineItem | description: - name: discountAdded | type: ManagedDiscount | description: - name: _id | type: string | description: Discount id. - name: name | type: TranslatedValue | description: Discount name: coupon name / discount rule name / merchant discount description. - name: original | type: string | description: Value in site default language. - name: translated | type: string | description: Translated value. - name: affectedLineItems | type: array | description: Line items discount applies to. - name: _id | type: string | description: Order line item id - name: name | type: ProductName | description: Item name. - name: amount | type: Price | description: Amount associated with this item. (Discount amount for item / additional fee amount for item) - name: totalAmount | type: Price | description: Discount amount. - name: discountRemoved | type: ManagedDiscount | description: - name: additionalFeeAdded | type: ManagedAdditionalFee | description: - name: _id | type: string | description: Additional fee id. - name: name | type: TranslatedValue | description: Additional fee name. - name: affectedLineItems | type: array | description: Line items additional fee applies to. - name: totalAmount | type: Price | description: Additional fee amount. - name: additionalFeeRemoved | type: ManagedAdditionalFee | description: - name: totalPriceChanged | type: TotalPriceChange | description: - name: originalTotal | type: Price | description: Order’s total price after discounts and tax. Before update - name: newTotal | type: Price | description: Order’s total price after discounts and tax. After update - name: shippingInformationChanged | type: ShippingInformationChange | description: - name: originalShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. Before update - name: total | type: Price | description: Order’s shipping price. - name: shippingTitle | type: string | description: Order’s shipping title. - name: newShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. After update - name: savedPaymentMethod | type: SavedPaymentMethod | description: Details of the payment method saved for the order. - name: name | type: string | description: Payment method name. - name: description | type: string | description: Payment method description. - name: authorizedPaymentCreated | type: AuthorizedPaymentCreated | description: Details of an authorized payment created. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: amount | type: Price | description: Payment amount. - name: lastFourDigits | type: string | description: The last 4 digits of the card number. - name: brand | type: string | description: Card issuer's brand. - name: authorizedPaymentCaptured | type: AuthorizedPaymentCaptured | description: Details of an authorized payment captured. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: amount | type: Price | description: Payment amount. - name: lastFourDigits | type: string | description: The last 4 digits of the card number. - name: brand | type: string | description: Card issuer's brand. - name: authorizedPaymentVoided | type: AuthorizedPaymentVoided | description: Details of an authorized payment voided. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: amount | type: Price | description: Payment amount. - name: lastFourDigits | type: string | description: The last 4 digits of the card number. - name: brand | type: string | description: Card issuer's brand. - name: refundInitiated | type: RefundInitiated | description: Details of an initiated refund process. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities. - name: refundId | type: string | description: Refund GUID. - name: amount | type: Price | description: Refund amount. - name: payments | type: array | description: Details about the payments being refunded. - ONE-OF: - name: regular | type: RegularPaymentRefund | description: Regular payment refund. - name: amount | type: Price | description: Refund amount. - name: lastFourDigits | type: string | description: The last 4 digits of the card number. - name: brand | type: string | description: Card issuer's brand. - name: giftCard | type: GiftCardPaymentRefund | description: Gift card payment refund. - name: giftCardPaymentId | type: string | description: Gift card payment GUID. - name: amount | type: Price | description: Refund amount. - name: membership | type: MembershipPaymentRefund | description: Membership payment refund. - name: membershipId | type: string | description: Membership GUID. - name: paymentId | type: string | description: Payment GUID. - name: externalRefund | type: boolean | description: Whether refund was made externally and manually on the payment provider's side. - name: reason | type: string | description: Reason for refund. - name: paymentRefunded | type: PaymentRefunded | description: Details of a refunded payment. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities. - name: refundId | type: string | description: Refund GUID. - name: payment | type: RefundedPayment | description: Details about the refunded payment. - name: paymentRefundFailed | type: PaymentRefundFailed | description: Details of a failed payment refund. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities. - name: refundId | type: string | description: Refund GUID. - name: payment | type: RefundedPayment | description: Details about the failed payment refund. - name: refundedAsStoreCredit | type: RefundedAsStoreCredit | description: Details of refund to store credit. - name: amount | type: Price | description: Refund amount. - name: reason | type: string | description: Reason for refund. - name: paymentPending | type: PaymentPending | description: Details of a pending payment. - ONE-OF: - name: regular | type: RegularPayment | description: Regular payment. - ONE-OF: - name: creditCardDetails | type: CreditCardDetails | description: Credit card details. - name: lastFourDigits | type: string | description: The last 4 digits of the card number. - name: brand | type: string | description: Card issuer's brand. - name: amount | type: Price | description: Payment amount. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: paymentCanceled | type: PaymentCanceled | description: Details of a canceled payment. - ONE-OF: - name: regular | type: RegularPayment | description: Regular payment. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: paymentDeclined | type: PaymentDeclined | description: Details of a declined payment. - ONE-OF: - name: regular | type: RegularPayment | description: Regular payment. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: receiptCreated | type: ReceiptCreated | description: Receipt was added for associated payment. - ONE-OF: - name: wixReceipt | type: WixReceipt | description: Receipt created by Wix. - name: receiptId | type: string | description: Receipt GUID. - name: displayNumber | type: string | description: Display number of receipt. - name: externalReceipt | type: ExternalReceipt | description: Receipt created by an external system. - name: receiptId | type: string | description: Receipt GUID. - name: displayNumber | type: string | description: Display number of receipt. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: receiptSent | type: ReceiptSent | description: Receipt sent to customer. - ONE-OF: - name: wixReceipt | type: WixReceipt | description: Receipt created by Wix. - name: externalReceipt | type: ExternalReceipt | description: Receipt created by an external system. - name: paymentId | type: string | description: Payment GUID of payment associated with this activity. - name: chargebackCreated | type: ChargebackCreated | description: Order received a chargeback for one of its payments. - name: paymentId | type: string | description: GUID of the payment that received a chargeback. - name: chargebackId | type: string | description: Chargeback GUID. - name: amount | type: Price | description: Chargeback amount. - name: paymentDetails | type: RegularPayment | description: Payment details. - name: chargebackReversed | type: ChargebackReversed | description: Chargeback reversed for one of the order's payments. - name: paymentId | type: string | description: GUID of the payment involved with the chargeback. - name: chargebackId | type: string | description: Chargeback GUID. - name: amount | type: Price | description: Chargeback amount. - name: reversalAmount | type: Price | description: Chargeback reversal amount. - name: paymentDetails | type: RegularPayment | description: Payment details. - name: _id | type: string | description: Activity GUID. - name: authorEmail | type: string | description: Activity author's email. - name: _createdDate | type: Date | description: Activity creation date and time. - name: activityType | type: ActivityType | description: Activity type. - enum: - ORDER_PLACED: New order was created and placed. - ORDER_PAID: Order payment was completed and confirmed. - ORDER_FULFILLED: Order items were marked as fulfilled (shipped or ready for pickup). - ORDER_NOT_FULFILLED: Order fulfillment status was changed to not fulfilled. - ORDER_CANCELED: Order was canceled by merchant or customer. - DOWNLOAD_LINK_SENT: Download link was sent for digital items in the order. - TRACKING_NUMBER_ADDED: Shipping tracking number was added to the order. - TRACKING_NUMBER_EDITED: Existing shipping tracking number was modified. - TRACKING_LINK_ADDED: Tracking link for shipment was added to the order. - SHIPPING_CONFIRMATION_EMAIL_SENT: Email confirming shipment was sent to the customer. - INVOICE_ADDED: Invoice document was added to the order. - INVOICE_REMOVED: Invoice was removed from the order. - INVOICE_SENT: Invoice was sent to the customer via email. - FULFILLER_EMAIL_SENT: Notification email was sent to the order fulfiller. - SHIPPING_ADDRESS_EDITED: Order's shipping address was modified. - EMAIL_EDITED: Order's contact email address was changed. - PICKUP_READY_EMAIL_SENT: Email notification for pickup readiness was sent. - MERCHANT_COMMENT: Comment added to the order by a merchant. - ORDER_PARTIALLY_PAID: Partial payment was received for the order. - DRAFT_ORDER_CHANGES_APPLIED: Changes were applied to a draft order. - SAVED_PAYMENT_METHOD: Payment method was saved for future use. - AUTHORIZED_PAYMENT_CREATED: Payment was authorized but not yet captured. - AUTHORIZED_PAYMENT_CAPTURED: Previously authorized payment was captured. - AUTHORIZED_PAYMENT_VOIDED: Previously authorized payment was voided. - REFUND_INITIATED: Refund process was initiated. - PAYMENT_REFUNDED: Payment was successfully refunded. - PAYMENT_REFUND_FAILED: Attempt to refund payment failed. - REFUNDED_AS_STORE_CREDIT: Refund was issued as store credit. - PAYMENT_PENDING: Payment is awaiting processing or confirmation. - PAYMENT_CANCELED: Payment was canceled before completion. - PAYMENT_DECLINED: Payment was declined by payment provider. - ORDER_PENDING: Order is awaiting approval or processing. - ORDER_REJECTED: Order was rejected by merchant. - RECEIPT_CREATED: Receipt was generated for a payment. - RECEIPT_SENT: Receipt was sent to the customer. - CHARGEBACK_CREATED: Chargeback was created for one of the order's payments. - CHARGEBACK_REVERSED: Chargeback was resolved in merchant's favor. - ORDER_REFUNDED: Order was refunded, either partially or fully. - name: attributionSource | type: AttributionSource | description: Order attribution source. - enum: UNSPECIFIED, FACEBOOK_ADS - name: createdBy | type: CreatedBy | description: GUID of the order's initiator. - ONE-OF: - name: userId | type: string | description: User GUID - when the order was created by a Wix user on behalf of a buyer. For example, via POS (point of service). - name: memberId | type: string | description: Member GUID - when the order was created by a **logged in** site visitor. - name: visitorId | type: string | description: Visitor GUID - when the order was created by a site visitor that was **not** logged in. - name: appId | type: string | description: App GUID - when the order was created by an external application. - name: channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order. - name: type | type: ChannelType | description: Sales channel that submitted the order. When creating an order via the API to record an external order, use the channel type that matches the original source. If no matching type exists, use `OTHER_PLATFORM`. - enum: - UNSPECIFIED: Unspecified sales channel. This value is not supported. - WEB: A web client. - POS: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). - EBAY: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). - AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). - OTHER_PLATFORM: Other sales platform. - WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). - WIX_INVOICES: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) - BACKOFFICE_MERCHANT: Wix merchant backoffice. - WISH: Wish sales channel. - CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). - GLOBAL_E: Global-E sales channel. - FACEBOOK: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). - ETSY: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). - TIKTOK: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). - FAIRE_COM: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). - PAYPAL_AGENTIC_CHECKOUT: PayPal Agentic Checkout sales channel. - STRIPE_AGENTIC_CHECKOUT: Stripe Agentic Checkout sales channel. - name: externalOrderId | type: string | description: Reference to an order GUID from an external system. Relevant when recording orders from external platforms. - name: externalOrderUrl | type: string | description: URL to the order in the external system. Relevant when recording orders from external platforms. - name: seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard. - name: checkoutId | type: string | description: Checkout GUID. - name: customFields | type: array | description: Custom fields. - name: value | type: Value | description: Custom field value. - ONE-OF: - name: nullValue | type: | description: - name: numberValue | type: number | description: - name: stringValue | type: string | description: - name: boolValue | type: boolean | description: - name: structValue | type: object | description: - name: listValue | type: ListValue | description: - name: values | type: array | description: - name: title | type: string | description: Custom field title. - name: translatedTitle | type: string | description: Translated custom field title. - name: balanceSummary | type: BalanceSummary | description: Balance summary. - name: balance | type: Balance | description: Current amount left to pay. - name: amount | type: string | description: Balance amount. A negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made. - name: formattedAmount | type: string | description: Amount formatted with currency symbol. - name: paid | type: Price | description: Sum of all approved and successful payments. The value includes payments that have subsequently been fully or partially refunded. - name: refunded | type: Price | description: Sum of all successfully refunded payments. - name: authorized | type: Price | description: Sum of all authorized payments. - name: pendingRefund | type: Price | description: Sum of all pending refund transactions. - name: pending | type: Price | description: Sum of all pending transactions. - name: chargeback | type: Price | description: Sum of all transaction chargebacks. - name: chargebackReversal | type: Price | description: Sum of all chargeback reversals. - name: platformFees | type: Price | description: Total platform fees actually charged across all payments. This reflects amounts collected, which may differ from the expected fees in `order.platformFeeSummary`. - name: totalMinusPlatformFees | type: Price | description: Order total after deducting platform fees. Represents the net amount payable to the merchant. - name: additionalFees | type: array | description: Additional fees applied to the order. - name: code | type: string | description: Additional fee's unique code for future processing. - name: name | type: string | description: Name of additional fee. - name: price | type: Price | description: Additional fee's price. - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee. - name: providerAppId | type: string | description: SPI implementer's `appId`. - name: priceBeforeTax | type: Price | description: Additional fee's price before tax. - name: priceAfterTax | type: Price | description: Additional fee's price after tax. - name: _id | type: string | description: Additional fee's id. - name: lineItemIds | type: array | description: Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order. - name: source | type: AdditionalFeeSource | description: Specifies the entity that added the additional fee. - enum: - SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin. - ITEM: The additional fee was added to the item by a catalog or custom line item. - MANUAL: The additional fee was added manually on request. - SHIPPING: The additional fee was added by the shipping provider. - PLATFORM: The additional fee was added by the Wix eCommerce platform. - name: extendedFields | type: ExtendedFields | description: Custom field data for the order object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls. - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order. - name: recipientInfo | type: AddressWithContact | description: Final recipient's address and contact details. This field represents who will ultimately receive the order. It may differ from `shippingInfo.logistics.shippingDestination` when: + The chosen shipping option is a pickup point or store pickup, where `shippingDestination` contains the pickup location. + No shipping option is selected. - name: tags | type: Tags | description: Order tags. [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction.md) are labels attached to entities, allowing for flexible categorization and data management. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: purchasedDate | type: Date | description: Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Used for migration from external systems. - name: businessLocation | type: Location | description: Order location. - name: _id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction.md). - name: name | type: string | description: Location name. - name: payAfterFreeTrial | type: PriceSummary | description: Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period. - name: platformFeeSummary | type: PlatformFeeSummary | description: Summary of platform fees for this order, including totals by charge type and a breakdown of individual fees. - name: total | type: Price | description: Total sum of all platform fees. - name: totalPassOn | type: Price | description: Total amount of platform fees with `PASS_ON` charge type. - name: totalAbsorbed | type: Price | description: Total amount of platform fees with `ABSORBED` charge type. - name: fees | type: array | description: Specific information about each platform fee. - name: name | type: TranslatableString | description: Platform fee name. - name: amount | type: Price | description: Platform fee amount. - name: lineItemId | type: string | description: GUID of the line item the platform fee applies to. - name: chargeType | type: ChargeType | description: Platform fee charge type. - enum: - PASS_ON: Platform fee passed on to buyer. This type increases the order total, and is visible to the buyer and merchant as an additional fee. - ABSORBED: Platform fee absorbed by merchant. This type does not increase the order total, and is only visible to the merchant. - name: percentageRate | type: string | description: Percentage rate charged as platform fee. The fee rate percentage expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%. Possible Errors: HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: ORDER_IS_REJECTED | Description: Order can't be updated because its status is `REJECTED`. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: ORDER_IS_PENDING | Description: Order can't be updated because its status is `PENDING`. ``` ### Examples ### Update buyer language and seen status Updates the buyer's language preference and marks the order as seen by a human ```javascript import { orders } from "@wix/ecom"; const orderId = "6da768ad-3c9f-444a-9465-7ae0b89fd305"; const order = { buyerLanguage: "fr", seenByAHuman: true }; async function updateOrder() { const response = await orders.updateOrder(orderId, order); } /* Promise resolves to: * { * "_id": "6da768ad-3c9f-444a-9465-7ae0b89fd305", * "number": "10107", * "_createdDate": "2024-01-04T13:57:09.968Z", * "_updatedDate": "2024-01-17T18:09:16.453Z", * "buyerLanguage": "fr", * "seenByAHuman": true, * "lineItems": [ * { * "id": "da4004fd-2ee3-48fa-bb7d-7624f1005348", * "productName": { * "original": "Ethiopian Yirgacheffe" * }, * "catalogReference": { * "catalogItemId": "93162737-1553-9cd6-6581-b1555bc150bf", * "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", * "options": { * "variantId": "3051f244-bb16-40c3-bd91-64fe27fbfbd1" * } * }, * "quantity": 1, * "totalDiscount": { * "amount": "0", * "formattedAmount": "$0.00" * }, * "descriptionLines": [ * { * "name": { * "original": "Weight", * "translated": "Weight" * }, * "plainText": { * "original": "500g", * "translated": "500g" * } * }, * { * "name": { * "original": "Ground for", * "translated": "Ground for" * } * }, * { * "name": { * "original": "What would you like us to print on the custom label?", * "translated": "What would you like us to print on the custom label?" * }, * "plainText": { * "original": "", * "translated": "" * } * } * ], * "image": { * "id": "4a5954_4da1a00418774f1bac924194b516155b~mv2.jpg", * "url": "https://static.wixstatic.com/media/4a5954_4da1a00418774f1bac924194b516155b~mv2.jpg/v1/fit/w_1500,h_1000,q_90/file.jpg", * "height": 1000, * "width": 1500 * }, * "physicalProperties": { * "sku": "", * "shippable": true * }, * "itemType": { * "preset": "PHYSICAL" * }, * "price": { * "amount": "18.00", * "formattedAmount": "$18.00" * }, * "totalPriceBeforeTax": { * "amount": "18.00", * "formattedAmount": "$18.00" * }, * "totalPriceAfterTax": { * "amount": "18.00", * "formattedAmount": "$18.00" * }, * "paymentOption": "FULL_PAYMENT_ONLINE", * "taxDetails": { * "taxRate": "0", * "totalTax": { * "amount": "0", * "formattedAmount": "$0.00" * } * }, * "locations": [] * }, * { * "id": "99479044-23e6-4dbb-9644-9104e4d99ee2", * "productName": { * "original": "Barista masterclass" * }, * "catalogReference": { * "catalogItemId": "8c449785-80ab-48ba-8d35-5d123a7a25b8", * "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", * "options": {} * }, * "quantity": 1, * "totalDiscount": { * "amount": "0", * "formattedAmount": "$0.00" * }, * "descriptionLines": [], * "itemType": { * "preset": "SERVICE" * }, * "price": { * "amount": "10", * "formattedAmount": "$10.00" * }, * "totalPriceBeforeTax": { * "amount": "10", * "formattedAmount": "$10.00" * }, * "totalPriceAfterTax": { * "amount": "10", * "formattedAmount": "$10.00" * }, * "paymentOption": "FULL_PAYMENT_OFFLINE", * "taxDetails": { * "taxRate": "0", * "totalTax": { * "amount": "0", * "formattedAmount": "$0.00" * } * }, * "locations": [] * } * ], * "buyerInfo": { * "contactId": "02b9675a-c6f0-4392-837f-3bde1d4b5e7c", * "email": "johndoe@gmail.com", * "memberId": "02b9675a-c6f0-4392-837f-3bde1d4b5e7c" * }, * "paymentStatus": "NOT_PAID", * "fulfillmentStatus": "PARTIALLY_FULFILLED", * "buyerLanguage": "en", * "weightUnit": "LB", * "currency": "USD", * "taxIncludedInPrices": false, * "priceSummary": { * "subtotal": { * "amount": "28.00", * "formattedAmount": "$28.00" * }, * "shipping": { * "amount": "5", * "formattedAmount": "$5.00" * }, * "tax": { * "amount": "0", * "formattedAmount": "$0.00" * }, * "discount": { * "amount": "1", * "formattedAmount": "$1.00" * }, * "total": { * "amount": "32.00", * "formattedAmount": "$32.00" * } * }, * "billingInfo": { * "address": { * "country": "US", * "subdivision": "US-NY", * "city": "New York", * "postalCode": "10173", * "addressLine": "525 5th Ave", * "countryFullname": "United States", * "subdivisionFullname": "New York" * }, * "contactDetails": { * "firstName": "John", * "lastName": "Doe", * "phone": "0555555555", * "company": "" * } * }, * "shippingInfo": { * "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc", * "code": "4a43a709-d4a0-e07e-33e6-9c8618796577", * "title": "Standard shipping", * "logistics": { * "deliveryTime": "3 - 5 business days", * "shippingDestination": { * "address": { * "country": "GB", * "subdivision": "GB-ENG", * "city": "London", * "postalCode": "N7 6DN", * "addressLine": "115 Hornsey Rd", * "countryFullname": "United Kingdom", * "subdivisionFullname": "England" * }, * "contactDetails": { * "firstName": "Jane", * "lastName": "Doe", * "phone": "0555555555", * "company": "" * } * } * }, * "cost": { * "price": { * "amount": "5", * "formattedAmount": "$5.00" * }, * "totalPriceBeforeTax": { * "amount": "5", * "formattedAmount": "$5.00" * }, * "totalPriceAfterTax": { * "amount": "5", * "formattedAmount": "$5.00" * } * }, * "region": { * "name": "Region 4" * } * }, * "status": "APPROVED", * "archived": false, * "appliedDiscounts": [ * { * "discountType": "GLOBAL", * "lineItemIds": [], * "merchantDiscount": { * "amount": { * "amount": "1", * "formattedAmount": "$1.00" * }, * "description": "Nice customer" * }, * "id": "7dcf2c6d-7fda-4733-b997-fe83b087083b" * } * ], * "activities": [ * { * "id": "8b010b96-5272-4d40-862a-ad579a90a074", * "_createdDate": "2024-01-04T12:02:10.501Z", * "type": "ORDER_PLACED" * } * ], * "attributionSource": "UNSPECIFIED", * "createdBy": { * "userId": "4a5954f0-8c60-4975-8210-c995c00f6077" * }, * "channelInfo": { * "type": "BACKOFFICE_MERCHANT" * }, * "seenByAHuman": true, * "customFields": [], * "balanceSummary": { * "balance": { * "amount": "32.00", * "formattedAmount": "$32.00" * }, * "paid": { * "amount": "0.00", * "formattedAmount": "$0.00" * }, * "refunded": { * "amount": "0.00", * "formattedAmount": "$0.00" * } * }, * "additionalFees": [], * "recipientInfo": { * "address": { * "country": "GB", * "subdivision": "GB-ENG", * "city": "London", * "postalCode": "N7 6DN", * "addressLine": "115 Hornsey Rd", * "countryFullname": "United Kingdom", * "subdivisionFullname": "England" * }, * "contactDetails": { * "firstName": "Jane", * "lastName": "Doe", * "phone": "0555555555", * "company": "" * } * } * } */ ``` ### Update buyer's email Updates the buyer's email address in an existing order ```javascript import { orders } from "@wix/ecom"; const orderId = "6da768ad-3c9f-444a-9465-7ae0b89fd305"; const order = { buyerInfo: { email: "a-new-buyerInfo-email@gmail.com" } }; async function updateOrder() { const response = await orders.updateOrder(orderId, order); } /* Promise resolves to: * { * "_id": "6da768ad-3c9f-444a-9465-7ae0b89fd305", * "number": "10107", * "_createdDate": "2024-01-04T13:57:09.968Z", * "_updatedDate": "2024-01-17T15:06:43.658Z", * "lineItems": [ * { * "id": "da4004fd-2ee3-48fa-bb7d-7624f1005348", * "productName": { * "original": "Ethiopian Yirgacheffe" * }, * "catalogReference": { * "catalogItemId": "93162737-1553-9cd6-6581-b1555bc150bf", * "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", * "options": { * "variantId": "3051f244-bb16-40c3-bd91-64fe27fbfbd1" * } * }, * "quantity": 1, * "totalDiscount": { * "amount": "0", * "formattedAmount": "$0.00" * }, * "descriptionLines": [ * { * "name": { * "original": "Weight", * "translated": "Weight" * }, * "plainText": { * "original": "500g", * "translated": "500g" * } * }, * { * "name": { * "original": "Ground for", * "translated": "Ground for" * } * }, * { * "name": { * "original": "What would you like us to print on the custom label?", * "translated": "What would you like us to print on the custom label?" * }, * "plainText": { * "original": "", * "translated": "" * } * } * ], * "image": { * "id": "4a5954_4da1a00418774f1bac924194b516155b~mv2.jpg", * "url": "https://static.wixstatic.com/media/4a5954_4da1a00418774f1bac924194b516155b~mv2.jpg/v1/fit/w_1500,h_1000,q_90/file.jpg", * "height": 1000, * "width": 1500 * }, * "physicalProperties": { * "sku": "", * "shippable": true * }, * "itemType": { * "preset": "PHYSICAL" * }, * "price": { * "amount": "18.00", * "formattedAmount": "$18.00" * }, * "totalPriceBeforeTax": { * "amount": "18.00", * "formattedAmount": "$18.00" * }, * "totalPriceAfterTax": { * "amount": "18.00", * "formattedAmount": "$18.00" * }, * "paymentOption": "FULL_PAYMENT_ONLINE", * "taxDetails": { * "taxRate": "0", * "totalTax": { * "amount": "0", * "formattedAmount": "$0.00" * } * }, * "locations": [] * }, * { * "id": "99479044-23e6-4dbb-9644-9104e4d99ee2", * "productName": { * "original": "Barista masterclass" * }, * "catalogReference": { * "catalogItemId": "8c449785-80ab-48ba-8d35-5d123a7a25b8", * "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", * "options": {} * }, * "quantity": 1, * "totalDiscount": { * "amount": "0", * "formattedAmount": "$0.00" * }, * "descriptionLines": [], * "itemType": { * "preset": "SERVICE" * }, * "price": { * "amount": "10", * "formattedAmount": "$10.00" * }, * "totalPriceBeforeTax": { * "amount": "10", * "formattedAmount": "$10.00" * }, * "totalPriceAfterTax": { * "amount": "10", * "formattedAmount": "$10.00" * }, * "paymentOption": "FULL_PAYMENT_OFFLINE", * "taxDetails": { * "taxRate": "0", * "totalTax": { * "amount": "0", * "formattedAmount": "$0.00" * } * }, * "locations": [] * } * ], * "buyerInfo": { * "contactId": "02b9675a-c6f0-4392-837f-3bde1d4b5e7c", * "email": "a-new-buyerInfo-email@gmail.com", * "memberId": "02b9675a-c6f0-4392-837f-3bde1d4b5e7c" * }, * "paymentStatus": "NOT_PAID", * "fulfillmentStatus": "PARTIALLY_FULFILLED", * "buyerLanguage": "en", * "weightUnit": "LB", * "currency": "USD", * "taxIncludedInPrices": false, * "priceSummary": { * "subtotal": { * "amount": "28.00", * "formattedAmount": "$28.00" * }, * "shipping": { * "amount": "5", * "formattedAmount": "$5.00" * }, * "tax": { * "amount": "0", * "formattedAmount": "$0.00" * }, * "discount": { * "amount": "1", * "formattedAmount": "$1.00" * }, * "total": { * "amount": "32.00", * "formattedAmount": "$32.00" * } * }, * "billingInfo": { * "address": { * "country": "US", * "subdivision": "US-NY", * "city": "New York", * "postalCode": "10173", * "addressLine": "525 5th Ave", * "countryFullname": "United States", * "subdivisionFullname": "New York" * }, * "contactDetails": { * "firstName": "John", * "lastName": "Doe", * "phone": "0555555555", * "company": "" * } * }, * "shippingInfo": { * "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc", * "code": "4a43a709-d4a0-e07e-33e6-9c8618796577", * "title": "Standard shipping", * "logistics": { * "deliveryTime": "3 - 5 business days", * "shippingDestination": { * "address": { * "country": "US", * "subdivision": "US-NY", * "city": "New York", * "postalCode": "10173", * "addressLine": "525 5th Ave", * "countryFullname": "United States", * "subdivisionFullname": "New York" * }, * "contactDetails": { * "firstName": "John", * "lastName": "Doe", * "phone": "0555555555", * "company": "" * } * } * }, * "cost": { * "price": { * "amount": "5", * "formattedAmount": "$5.00" * }, * "totalPriceBeforeTax": { * "amount": "5", * "formattedAmount": "$5.00" * }, * "totalPriceAfterTax": { * "amount": "5", * "formattedAmount": "$5.00" * } * }, * "region": { * "name": "Region 4" * } * }, * "status": "APPROVED", * "archived": false, * "appliedDiscounts": [ * { * "discountType": "GLOBAL", * "lineItemIds": [], * "merchantDiscount": { * "amount": { * "amount": "1", * "formattedAmount": "$1.00" * }, * "description": "Nice customer" * }, * "id": "7dcf2c6d-7fda-4733-b997-fe83b087083b" * } * ], * "activities": [ * { * "id": "8b010b96-5272-4d40-862a-ad579a90a074", * "_createdDate": "2024-01-04T12:02:10.501Z", * "type": "ORDER_PLACED" * } * ], * "attributionSource": "UNSPECIFIED", * "createdBy": { * "userId": "4a5954f0-8c60-4975-8210-c995c00f6077" * }, * "channelInfo": { * "type": "BACKOFFICE_MERCHANT" * }, * "seenByAHuman": true, * "customFields": [], * "balanceSummary": { * "balance": { * "amount": "32.00", * "formattedAmount": "$32.00" * }, * "paid": { * "amount": "0.00", * "formattedAmount": "$0.00" * }, * "refunded": { * "amount": "0.00", * "formattedAmount": "$0.00" * } * }, * "additionalFees": [], * "recipientInfo": { * "address": { * "country": "US", * "subdivision": "US-NY", * "city": "New York", * "postalCode": "10173", * "addressLine": "525 5th Ave", * "countryFullname": "United States", * "subdivisionFullname": "New York" * }, * "contactDetails": { * "firstName": "John", * "lastName": "Doe", * "phone": "0555555555", * "company": "" * } * } * } */ ``` ### updateOrder (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { orders } from '@wix/ecom'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { orders }, // Include the auth strategy and host as relevant }); async function updateOrder(_id,order) { const response = await myWixClient.orders.updateOrder(_id,order); }; ``` ---