-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/master' into events---policies
- Loading branch information
Showing
8 changed files
with
2,022 additions
and
44 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| SortOrder: 0 | ||
| # About the eCommerce Abandoned Checkouts API | ||
|
|
||
| When a customer begins an eCommerce Checkout process but doesn't complete it (for example, after closing their browser tab before putting in their payment details and making a payment), that checkout becomes an abandoned checkout. The Abandoned Checkouts API allows an app developer to help a customer recover their abandoned checkout (return to their incomplete checkout and complete the checkout). When a customer completes their checkout and makes a purchase, the checkout becomes an [order](https://dev.wix.com/api/rest/wix-ecommerce/orders). | ||
|
|
||
| An abandoned checkout holds buyer details, price, reference to the initial checkout, a checkout URL, and more. | ||
|
|
||
| The eCommerce Abandoned Checkouts API provides functionality for [getting information about an abandoned checkout](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/get-abandoned-checkout) and [retrieving a list of abandoned checkouts](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/query-abandoned-checkouts). You can also listen for events when an abandoned checkout is [created](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/abandoned-checkout-created-webhook) and [recovered](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/abandoned-checkout-recovered-webhook). | ||
|
|
||
| To assist in migration from the Stores to eCommerce APIs, please refer to the [Stores Cart to eCommerce Checkout Conversion Table](https://dev.wix.com/api/rest/wix-ecommerce/checkout/stores-cart-to-ecommerce-checkout-object-conversion). | ||
|
|
||
| ## Terminology | ||
|
|
||
| + **Recovered**: When a customer returns to their abandoned checkout and completes the checkout. | ||
|
|
||
| + **Activities**: This property is only relevant if the site owner set up [automations in the Dashboard](https://support.wix.com/en/article/wix-automations-creating-a-new-automation). The `activities` property is a list of all automation activities performed by [Wix Automations](https://support.wix.com/en/article/wix-automations-getting-started) regarding the abandoned checkout. Wix Automations updates the `activities` field for each actvity in the automation flow. For example, if a site owner set up an automation to send a notification to a site visitor an hour after their abandoned checkout is created, Wix automations does the following: | ||
| + Updates the `activities` field to `SCHEDULED` when the abandoned checkout is created. | ||
| + Updates the `activities` field to `NOTIFICATION_SENT` after an hour, when the notification is sent to the site visitor. | ||
|
|
||
|
|
||
| Other `actvities` include: | ||
| + `EMAIL_SENT` | ||
| + `EMAIL_NOT_SENT` | ||
| + `TASK_CREATED` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| SortOrder: 1 | ||
| # Abandoned Checkouts: Sample Use Case & Flow | ||
|
|
||
| This article shares some possible use cases your app could support, as well as an example flow that could support each | ||
| use case. You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your | ||
| app's implementation. | ||
|
|
||
| ## Redirect a site visitor with an abandoned checkout back to their checkout page | ||
|
|
||
| If a site visitor starts a checkout but doesn't complete it, you can redirect them to their checkout page. You can also check whether the site visitor has recovered their abandoned checkout and completed the purchase. | ||
|
|
||
| To redirect the site visitor to their checkout page: | ||
|
|
||
| 1. Using the [Abandoned Checkout Created Webhook](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/abandoned-checkout-created-webhook), listen for an event when an abandoned checkout is created (a checkout was not completed). | ||
|
|
||
| 2. Save the newly created abandoned checkout's ID (`entityId` field) and `checkoutUrl` from the above webhook's payload. Then send a marketing campaign with the `checkoutURL` to your site visitor, redirecting them to their checkout page. | ||
|
|
||
| 3. After the marketing campaign, call [Get Abandoned Checkout](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/get-abandoned-checkout) with the abandoned checkout's ID. Then check the `status` field in the response to see if the abandoned checkout has been recovered. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| SortOrder: 2 | ||
| # Abandoned Checkouts: Supported Filters and Sorting | ||
|
|
||
| The table below shows field support for filters and sorting for the base set of abandoned checkout properties. | ||
|
|
||
| | Field | Supported Filters | Sortable | | ||
| | ---------------------------- | --------------------------------------------- | -------- | | ||
| | `id` | `$eq`, `$ne`, `$in`, `$exists` | | | ||
| | `createdDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable | | ||
| | `updatedDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable | | ||
| | `status` | `$eq` | Sortable | | ||
| | `buyerInfo.email` | `$eq` | | | ||
| | `totalPrice.amount` | `$eq`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable | | ||
| | `totalPrice.convertedAmount` | `$eq`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable | |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters