docs: fix physical gift card lifecycle numbering#1680
docs: fix physical gift card lifecycle numbering#1680Krishnauprit18 wants to merge 1 commit intohotwax:user-guides-pubfrom
Conversation
1. Fixed the numbering issue in the physical gift card lifecycle where the sequence was correct until point 7, but “Orders Allocated to Store” was incorrectly numbered as point 5 instead of point 8. The remaining lifecycle steps now continue correctly through point 11. 2. Also corrected “Orders ID” to “Order IDs” in the point 3 sync heading. 3. Fixes hotwax#1622
There was a problem hiding this comment.
Pull request overview
Fixes a documentation numbering inconsistency in the Physical Gift Cards lifecycle steps within the Gift Card Orders Lifecycle BPM, aligning the sequence with the intended step progression (Issue #1622).
Changes:
- Corrected the step number for “Orders Allocated to Store” and renumbered subsequent physical lifecycle headings through step 11.
- Fixed the Physical Gift Cards step 3 heading from “Orders ID” to “Order IDs”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| NetSuite's SuiteScript then consumes this order data and generates orders in the <mark style="color:orange;">**"Pending Fulfillment"**</mark> status. | ||
|
|
||
| ### 3. Synchronize Orders ID and Item Line IDs to HotWax Commerce | ||
| ### 3. Synchronize Order IDs and Item Line IDs to HotWax Commerce |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the gift card orders lifecycle documentation by correcting a typo and renumbering several section headings. The review feedback focuses on aligning these headings with the HotWax Style Guide, specifically recommending the use of sentence-style capitalization and action-oriented phrasing for better consistency and readability.
| NetSuite's SuiteScript then consumes this order data and generates orders in the <mark style="color:orange;">**"Pending Fulfillment"**</mark> status. | ||
|
|
||
| ### 3. Synchronize Orders ID and Item Line IDs to HotWax Commerce | ||
| ### 3. Synchronize Order IDs and Item Line IDs to HotWax Commerce |
There was a problem hiding this comment.
This heading uses title-style capitalization. According to the HotWax Style Guide, headings should use sentence-style capitalization, where only the first word and proper nouns are capitalized.
| ### 3. Synchronize Order IDs and Item Line IDs to HotWax Commerce | |
| ### 3. Synchronize order IDs and item line IDs to HotWax Commerce |
References
- Use sentence-style capitalization for titles and headings: capitalize the first word, lowercase the rest. Exceptions: Proper nouns, including brand, product, and solution names are always capitalized. (link)
| * The order status is automatically updated from <mark style="color:orange;">**"Approved"**</mark> to <mark style="color:orange;">**"Completed"**</mark> in HotWax Commerce. | ||
|
|
||
| ### 5. Orders Allocated to Store | ||
| ### 8. Orders Allocated to Store |
There was a problem hiding this comment.
This heading should be action-oriented and use sentence-style capitalization as per the HotWax Style Guide.
| ### 8. Orders Allocated to Store | |
| ### 8. Allocate orders to store |
| * Finally, when the item is marked as shipped in the `Fulfillment App`, the fulfillment status is then updated to <mark style="color:orange;">**"Shipped"**</mark>. | ||
|
|
||
| ### 6. Activation of Gift Cards | ||
| ### 9. Activation of Gift Cards |
There was a problem hiding this comment.
| This activation step ensures that the gift card is fully functional and customers can use the unique serial number they received in their email to redeem the value stored in the gift card. | ||
|
|
||
| ### 7. Order Item Shipped | ||
| ### 10. Order Item Shipped |
There was a problem hiding this comment.
| This marks the completion of physical gift card orders in NetSuite. | ||
|
|
||
| ### 8. Synchronize Fulfillment Updates to eCommerce | ||
| ### 11. Synchronize Fulfillment Updates to eCommerce |
There was a problem hiding this comment.
This heading should use sentence-style capitalization.
| ### 11. Synchronize Fulfillment Updates to eCommerce | |
| ### 11. Synchronize fulfillment updates to eCommerce |
References
- Use sentence-style capitalization for titles and headings. (link)
Fixed the numbering issue in the physical gift card lifecycle where the sequence was correct until point 7, but “Orders Allocated to Store” was incorrectly numbered as point 5 instead of point 8. The remaining lifecycle steps now continue correctly through point 11.
Also corrected “Orders ID” to “Order IDs” in the point 3 sync heading.
Fixes Fix: Incorrect sequence numbering in "Gift Card Orders Lifecycle" documentation #1622