Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove beta mention form cancel order #801

Merged
merged 3 commits into from
Nov 8, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/guides/Orders/order-canceling-improvements-beta.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Order canceling improvements (Beta)"
slug: "order-canceling-improvements-beta"
hidden: true
title: "Order canceling improvements"
slug: "order-canceling-improvements"
hidden: false
createdAt: "2023-08-17T13:21:05.725Z"
updatedAt: "2023-08-17T13:17:33.816Z"
updatedAt: "2023-11-17T13:17:33.816Z"
---

There are many scenarios where canceling an order is necessary, whether on behalf of sellers, marketplaces or shoppers. To cover multiple scenarios, we made the following improvements in order cancellation:
Expand All @@ -13,7 +13,9 @@

In each case, both seller and marketplace will be notified about changes, have access to information about each other's reasons for canceling and/or denying a cancel request, and sellers will know when the shopper requested the cancellation.

> In this article, the term marketplace will refer to VTEX marketplace and seller to VTEX seller. For more information, see Marketplace strategies at VTEX.
For information about this feature in VTEX Admin, see [Declining order cancelation](https://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4).

> In this article, the term marketplace will refer to VTEX marketplace and seller to VTEX seller. For more information, see [Marketplace strategies at VTEX](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402).

## Permissions

Expand Down Expand Up @@ -48,16 +50,16 @@

**POST -** `https://{accountName}.{environment}.com.br/api/oms/pvt/orders/{orderId}/cancel`

**cURL**

Check warning on line 53 in docs/guides/Orders/order-canceling-improvements-beta.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint

[markdownlint] reported by reviewdog 🐶 MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "cURL"] Raw Output: docs/guides/Orders/order-canceling-improvements-beta.md:53 MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "cURL"]

```curl
curl --request post \
--url 'https://{accountname}.{environment}.com.br/api/oms/pvt/orders/{{orderId}}/cancel' \

Check warning on line 57 in docs/guides/Orders/order-canceling-improvements-beta.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint

[markdownlint] reported by reviewdog 🐶 MD010/no-hard-tabs Hard tabs [Column: 1] Raw Output: docs/guides/Orders/order-canceling-improvements-beta.md:57:1 MD010/no-hard-tabs Hard tabs [Column: 1]
--header 'Accept: application/json' \

Check warning on line 58 in docs/guides/Orders/order-canceling-improvements-beta.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint

[markdownlint] reported by reviewdog 🐶 MD010/no-hard-tabs Hard tabs [Column: 1] Raw Output: docs/guides/Orders/order-canceling-improvements-beta.md:58:1 MD010/no-hard-tabs Hard tabs [Column: 1]
--header 'Content-Type: application/json' \

Check warning on line 59 in docs/guides/Orders/order-canceling-improvements-beta.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint

[markdownlint] reported by reviewdog 🐶 MD010/no-hard-tabs Hard tabs [Column: 1] Raw Output: docs/guides/Orders/order-canceling-improvements-beta.md:59:1 MD010/no-hard-tabs Hard tabs [Column: 1]
--header 'X-VTEX-API-AppKey: ' \

Check warning on line 60 in docs/guides/Orders/order-canceling-improvements-beta.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint

[markdownlint] reported by reviewdog 🐶 MD010/no-hard-tabs Hard tabs [Column: 1] Raw Output: docs/guides/Orders/order-canceling-improvements-beta.md:60:1 MD010/no-hard-tabs Hard tabs [Column: 1]
--header 'X-VTEX-API-AppToken: ' \

Check warning on line 61 in docs/guides/Orders/order-canceling-improvements-beta.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint

[markdownlint] reported by reviewdog 🐶 MD010/no-hard-tabs Hard tabs [Column: 1] Raw Output: docs/guides/Orders/order-canceling-improvements-beta.md:61:1 MD010/no-hard-tabs Hard tabs [Column: 1]
--data '{

Check warning on line 62 in docs/guides/Orders/order-canceling-improvements-beta.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint

[markdownlint] reported by reviewdog 🐶 MD010/no-hard-tabs Hard tabs [Column: 1] Raw Output: docs/guides/Orders/order-canceling-improvements-beta.md:62:1 MD010/no-hard-tabs Hard tabs [Column: 1]
"reason": "string",
"requestedByUser": boolean
}'
Expand Down Expand Up @@ -149,7 +151,7 @@

A common scenario for using this endpoint is when the marketplace works with sellers whose products are made on demand by each purchase. If a shopper contacts the marketplace customer care service via telephone demanding the order cancellation, and the marketplace cancels the order, now the seller can deny the cancellation request.

>⚠️ To deny an order cancellation request, the order status in the marketplace and seller must be the following:<p><ul><li>**Marketplace status:** `waiting-for-seller-decision`.</li><li>**Seller status:** `cancellation-requested`.</li></ul></p>

Check warning on line 154 in docs/guides/Orders/order-canceling-improvements-beta.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint

[markdownlint] reported by reviewdog 🐶 MD033/no-inline-html Inline HTML [Element: li] Raw Output: docs/guides/Orders/order-canceling-improvements-beta.md:154:120 MD033/no-inline-html Inline HTML [Element: li]

Check warning on line 154 in docs/guides/Orders/order-canceling-improvements-beta.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint

[markdownlint] reported by reviewdog 🐶 MD033/no-inline-html Inline HTML [Element: li] Raw Output: docs/guides/Orders/order-canceling-improvements-beta.md:154:183 MD033/no-inline-html Inline HTML [Element: li]

Check warning on line 154 in docs/guides/Orders/order-canceling-improvements-beta.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint

[markdownlint] reported by reviewdog 🐶 MD033/no-inline-html Inline HTML [Element: p] Raw Output: docs/guides/Orders/order-canceling-improvements-beta.md:154:113 MD033/no-inline-html Inline HTML [Element: p]

### Diagram

Expand Down