Skip to content

EDU-18068 - Add explanation on change v1 and v2 nomenclature#2703

Open
mariananantua wants to merge 2 commits into
mainfrom
update-change-order-guide
Open

EDU-18068 - Add explanation on change v1 and v2 nomenclature#2703
mariananantua wants to merge 2 commits into
mainfrom
update-change-order-guide

Conversation

@mariananantua
Copy link
Copy Markdown
Contributor

@mariananantua mariananantua commented May 28, 2026

Summary

Update Order modifications guide with the change v1 and change v2 nomenclature, explaining to what feature each refer. Refers to EDU-18068.


Type of change

  • New content — Adds new documentation.
  • Content update — Improves existing documentation (clarity, structure, examples, accuracy).
  • Bug fix — Fixes markdown issues.
  • Editorial fix — Spelling, grammar, or minor copy edits that don’t change meaning.
  • Content removal — Deletes deprecated or obsolete content.

Checklist

  • The content follows the VTEX Style Guide.
  • Markdown renders correctly (headings, lists, tables, callouts).
  • Links, images, code blocks, and examples are valid.
  • Terminology, product names, and API references are consistent.
  • Frontmatter (title, description, tags, slug) is correct
  • Files follow the expected folder structure and naming conventions.

AI review instructions

This repository supports automated AI reviews for Markdown files in the docs folder, except docs/localization.

To run reviews on this PR, add at least one of the following labels:

  • AI style review: evaluates tone and adherence to VTEX style guidelines.
  • AI grammar review: identifies grammar and spelling issues.

Once at least one label is added, the review(s) will run automatically.

After the review is completed, the corresponding label will be removed and the label AI reviewed will be added to the PR.

Note

To rerun a review, remove and add the desired label again.

@mariananantua mariananantua self-assigned this May 28, 2026
@mariananantua mariananantua added documentation AI grammar review Trigger AI grammar review workflow AI style review Trigger AI style review workflow labels May 28, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 28, 2026

👁️‍🗨️ Preview changes on Developer Portal

You can use the link below to load the Developer Portal in preview mode with the changes from this branch:

👉 Open preview environment

Below is the list of modified pages and their corresponding preview URLs:

File Preview URL Sidebar
docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md https://developers.vtex.com/docs/guides/order-modifications ✅ Listed

@github-actions
Copy link
Copy Markdown
Contributor

🏷️ Frontmatter errors

docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md

Field issues

Field Error
excerpt Missing required field: 'excerpt'

@mariananantua mariananantua force-pushed the update-change-order-guide branch from ebdfae8 to 9bfcbb5 Compare May 28, 2026 18:43
Order modifications is a feature that allows your store to modify the items or prices of an order. With this feature, the store can handle potential changes in orders due to customer mistakes, product unavailability, and the inclusion of discounts, among other reasons. Learn more about how it works and its restrictions in the article [Changing items from a completed order](https://help.vtex.com/en/tutorial/changing-items-from-a-complete-order--tutorials_190).

>⚠️ The [Order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) feature is not applicable to the Catalog API - Seller Portal.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD028/no-blanks-blockquote Blank line inside blockquote

@github-actions github-actions Bot removed the AI style review Trigger AI style review workflow label May 28, 2026
@github-actions
Copy link
Copy Markdown
Contributor

✏️ Grammar review summary

docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md

Corrected minor grammatical issues by adding missing definite articles ('the') before 'API', 'Change v1 API', and 'Change v2 API'.


Was this feedback useful?

  • Yes
  • No

Review made on commit ebdfae8

@github-actions github-actions Bot added the AI reviewed Check to indicate the PR received an AI-based review label May 28, 2026
Comment thread docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md Outdated
Comment thread docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md Outdated
Comment thread docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md Outdated
@github-actions github-actions Bot removed the AI grammar review Trigger AI grammar review workflow label May 28, 2026
@github-actions
Copy link
Copy Markdown
Contributor

🏷️ Frontmatter errors

docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md

Field issues

Field Error
excerpt Missing required field: 'excerpt'

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

🏷️ Frontmatter errors

docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md

Field issues

Field Error
excerpt Missing required field: 'excerpt'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI reviewed Check to indicate the PR received an AI-based review documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants