Fix typos and broken links in learn-shopify by rachitaarsh-jpg · Pull Request #1688 · hotwax/oms-documentation

rachitaarsh-jpg · 2026-05-05T14:01:02Z

This PR addresses several typos and grammar errors in the learn-shopify documentation, and fixes broken links caused by automated corrections.

Related Issue: #1690

gemini-code-assist

Code Review

This pull request updates the Shopify integration documentation by adjusting terminology and casing. However, the changes introduce many serious technical errors that break the documentation's rendering and accuracy. Feedback highlights broken XML and HTML tags, invalid GitBook hint block syntax, and incorrect technical terms such as "webtoons" and "Boris." Furthermore, the updates corrupt API references, file extensions, and hyperlink attributes, which will lead to broken links and invalid technical guides.

gemini-code-assist · 2026-05-05T14:03:15Z


 ```
-<ShopifyShopTypeMapping mappedKey="{Shopify Kit Type}" mappedTypeId="SHOPIFY_PRODUCT_TYPE" mappedValue="MARKETING_PKG_PICK" shopId="SHOP"/>
+<ShopifyShopTypeMapping mappedKey="{Shopify Kit Type}" mappedTypeId="SHOPIFY_PRODUCT_TYPE" mapped Value="MARKETING_PKG_PICK" shopId="SHOP"/>


The change introduces a space in the XML attribute name mapped Value. This will result in invalid XML and break the code snippet.

Suggested change

<ShopifyShopTypeMapping mappedKey="{Shopify Kit Type}" mappedTypeId="SHOPIFY_PRODUCT_TYPE" mapped Value="MARKETING_PKG_PICK" shopId="SHOP"/>

<ShopifyShopTypeMapping mappedKey="{Shopify Kit Type}" mappedTypeId="SHOPIFY_PRODUCT_TYPE" mappedValue="MARKETING_PKG_PICK" shopId="SHOP"/>

gemini-code-assist · 2026-05-05T14:03:15Z

 Given:

-<table data-header-hidden data-full-width="false"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Quantity on hand</td><td>100 Units</td></tr><tr><td>Reserved quantities</td><td>5 Units</td></tr><tr><td>Safety stock</td><td>5 Units</td></tr><tr><td>Threshold</td><td>5 Units</td></tr><tr><td>Orders in brokering queue</td><td>5 Units</td></tr><tr><td>Excluded facilities' ATP</td><td>5 Units</td></tr></tbody></table>
+<table data-header-hidden data-full-width="false"><thead><try><th></th><th></th></tr></thead><tbody><try><td>Quantity on hand</td><td>100 Units</td></tr><try><td>Reserved quantities</td><td>5 Units</td></tr><try><td>Safety stock</td><td>5 Units</td></tr><try><td>Threshold</td><td>5 Units</td></tr><try><td>Orders in brokering queue</td><td>5 Units</td></tr><try><td>Excluded facilities' ATP</td><td>5 Units</td></tr></tbody></table>


The HTML table tags <tr> and <th> have been incorrectly changed to <try> and <the>. This will break the table rendering in the documentation.

Suggested change

<table data-header-hidden data-full-width="false"><thead><try><th></th><th></th></tr></thead><tbody><try><td>Quantity on hand</td><td>100 Units</td></tr><try><td>Reserved quantities</td><td>5 Units</td></tr><try><td>Safety stock</td><td>5 Units</td></tr><try><td>Threshold</td><td>5 Units</td></tr><try><td>Orders in brokering queue</td><td>5 Units</td></tr><try><td>Excluded facilities' ATP</td><td>5 Units</td></tr></tbody></table>

<table data-header-hidden data-full-width="false"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Quantity on hand</td><td>100 Units</td></tr><tr><td>Reserved quantities</td><td>5 Units</td></tr><tr><td>Safety stock</td><td>5 Units</td></tr><tr><td>Threshold</td><td>5 Units</td></tr><tr><td>Orders in brokering queue</td><td>5 Units</td></tr><tr><td>Excluded facilities' ATP</td><td>5 Units</td></tr></tbody></table>

gemini-code-assist · 2026-05-05T14:03:15Z

 4. **Deleting Existing Products:** Ensuring data integrity by removing products from HotWax Commerce when they're deleted from the Shopify store.

-<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><mark style="color:red;"><strong>How to set up jobs in Job Manager App</strong></mark></td><td>Learn how to set up jobs in HotWax Commerce to Synchronize Product Data from Shopify</td><td></td><td></td><td></td><td><a href="/documents/retail-operations/workflow/job-management/job-details.md">Job Manager</a></td><td><a href="../../../.gitbook/assets/inventory.png">inventory.png</a></td></tr><tr><td><mark style="color:red;"><strong>FAQ</strong></mark></td><td>Find answers to commonly asked questions</td><td></td><td></td><td></td><td><a href="https://www.hotwax.co/frequently-asked-questions">https://www.hotwax.co/frequently-asked-questions</a></td><td><a href="../../../.gitbook/assets/faq-card.png">faq-card.png</a></td></tr><tr><td><mark style="color:red;"><strong>Contact us</strong></mark></td><td>Looking for more answers?<br><br>Connect with our experts to achieve true omnichannel integration</td><td></td><td></td><td></td><td><a href="https://www.hotwax.co/connect">https://www.hotwax.co/connect</a></td><td><a href="/documents/retail-operations/.gitbook/assets/contact.png">Contact.png</a></td></tr></tbody></table>
+<table data-view="cards"><thead><try><th></th><th></th><th></th><the data-hidden></th><the data-hidden></th><the data-hidden data-card-target data-type="content-ref"></th><the data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><try><td><mark style="color:red;"><strong>How to set up jobs in Job Manager App</strong></mark></td><td>Learn how to set up jobs in HotWax Commerce to Synchronize Product Data from Shopify</td><td></td><td></td><td></td><td><a ref="/documents/retail-operations/workflow/job-management/job-details.md">Job Manager</a></td><td><a ref="../../../.gitbook/assets/inventory.png">inventory.png</a></td></tr><try><td><mark style="color:red;"><strong>FAQ</strong></mark></td><td>Find answers to commonly asked questions</td><td></td><td></td><td></td><td><a href="https://www.hotwax.co/frequently-asked-questions">https://www.hotwax.co/frequently-asked-questions</a></td><td><a ref="../../../.gitbook/assets/faq-card.png">faq-card.png</a></td></tr><try><td><mark style="color:red;"><strong>Contact us</strong></mark></td><td>Looking for more answers?<br><br>Connect with our experts to achieve true omnichannel integration</td><td></td><td></td><td></td><td><a href="https://www.hotwax.co/connect">https://www.hotwax.co/connect</a></td><td><a ref="/documents/retail-operations/.gitbook/assets/contact.png">Contact.png</a></td></tr></tbody></table>


The href attribute in the <a> tags has been incorrectly changed to ref. This will break all the links in this table.

Suggested change

<table data-view="cards"><thead><try><th></th><th></th><th></th><the data-hidden></th><the data-hidden></th><the data-hidden data-card-target data-type="content-ref"></th><the data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><try><td><mark style="color:red;"><strong>How to set up jobs in Job Manager App</strong></mark></td><td>Learn how to set up jobs in HotWax Commerce to Synchronize Product Data from Shopify</td><td></td><td></td><td></td><td><a ref="/documents/retail-operations/workflow/job-management/job-details.md">Job Manager</a></td><td><a ref="../../../.gitbook/assets/inventory.png">inventory.png</a></td></tr><try><td><mark style="color:red;"><strong>FAQ</strong></mark></td><td>Find answers to commonly asked questions</td><td></td><td></td><td></td><td><a href="https://www.hotwax.co/frequently-asked-questions">https://www.hotwax.co/frequently-asked-questions</a></td><td><a ref="../../../.gitbook/assets/faq-card.png">faq-card.png</a></td></tr><try><td><mark style="color:red;"><strong>Contact us</strong></mark></td><td>Looking for more answers?<br><br>Connect with our experts to achieve true omnichannel integration</td><td></td><td></td><td></td><td><a href="https://www.hotwax.co/connect">https://www.hotwax.co/connect</a></td><td><a ref="/documents/retail-operations/.gitbook/assets/contact.png">Contact.png</a></td></tr></tbody></table>

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><mark style="color:red;"><strong>How to set up jobs in Job Manager App</strong></mark></td><td>Learn how to set up jobs in HotWax Commerce to Synchronize Product Data from Shopify</td><td></td><td></td><td></td><td><a href="/documents/retail-operations/workflow/job-management/job-details.md">Job Manager</a></td><td><a href="../../../.gitbook/assets/inventory.png">inventory.png</a></td></tr><tr><td><mark style="color:red;"><strong>FAQ</strong></mark></td><td>Find answers to commonly asked questions</td><td></td><td></td><td></td><td><a href="https://www.hotwax.co/frequently-asked-questions">https://www.hotwax.co/frequently-asked-questions</a></td><td><a href="../../../.gitbook/assets/faq-card.png">faq-card.png</a></td></tr><tr><td><mark style="color:red;"><strong>Contact us</strong></mark></td><td>Looking for more answers?<br><br>Connect with our experts to achieve true omnichannel integration</td><td></td><td></td><td></td><td><a href="https://www.hotwax.co/connect">https://www.hotwax.co/connect</a></td><td><a href="/documents/retail-operations/.gitbook/assets/contact.png">Contact.png</a></td></tr></tbody></table>

gemini-code-assist · 2026-05-05T14:03:15Z

 **Example:**

-> https://admin.shopify.com/admin/{shop-name}/products/count.json https://admin.shopify.com/admin/{shop-name}/variants/count.json
+> https://admin.shopify.com/admin/{shop-name}/products/count.json https://admin.shopify.com/admin/{shop-name}/variants/count.Jason


The file extension .json has been incorrectly changed to .Jason. This will break the technical accuracy of the URL example.

Suggested change

> https://admin.shopify.com/admin/{shop-name}/products/count.json https://admin.shopify.com/admin/{shop-name}/variants/count.Jason

> https://admin.shopify.com/admin/{shop-name}/products/count.json https://admin.shopify.com/admin/{shop-name}/variants/count.json

gemini-code-assist · 2026-05-05T14:03:15Z

 **HotWax**

-**To retrieve counts in HotWax, follow these structured steps in the webtools:**
+**To retrieve counts in HotWax, follow these structured steps in the webtoons:**


The term webtools has been incorrectly changed to webtoons. Webtools is the correct technical term for the HotWax administration interface.

Suggested change

**To retrieve counts in HotWax, follow these structured steps in the webtoons:**

**To retrieve counts in HotWax, follow these structured steps in the webtools:**

gemini-code-assist · 2026-05-05T14:03:15Z

 **9. read\_merchant\_managed\_fulfillment\_orders** **Access Scope:** [FulfillmentOrder](https://shopify.dev/docs/api/admin-rest/latest/resources/fulfillmentorder) resources assigned to merchant-managed locations **Reason:** HotWax Commerce requires access to fulfillment orders managed by merchants to streamline order fulfillment operations effectively.

-**10. read\_orders** **Access Scope:** [Abandoned checkouts](https://shopify.dev/docs/api/admin-rest/latest/resources/abandoned-checkouts), [Customer](https://shopify.dev/docs/api/admin-rest/latest/resources/customer), [Fulfillment](https://shopify.dev/docs/api/admin-rest/latest/resources/fulfillment), [Order](https://shopify.dev/docs/api/admin-rest/latest/resources/order), and [Transaction](https://shopify.dev/docs/api/admin-rest/latest/resources/transaction) resources. **Reason:** HotWax Commerce imports all orders and updates to ensure comprehensive order management and accurate fulfillment processes.
+**10. Read\_orders** **Access Scope:** [Abandoned checkouts](https://shopify.dev/docs/api/admin-rest/latest/resources/abandoned-checkouts), [Customer](https://shopify.dev/docs/api/admin-rest/latest/resources/customer), [Fulfillment](https://shopify.dev/docs/api/admin-rest/latest/resources/fulfillment), [Order](https://shopify.dev/docs/api/admin-rest/latest/resources/order), and [Transaction](https://shopify.dev/docs/api/admin-rest/latest/resources/transaction) resources. **Reason:** HotWax Commerce imports all orders and updates to ensure comprehensive order management and accurate fulfillment processes.


Shopify access scopes (e.g., read_orders) are technical identifiers and should remain lowercase. Changing them to sentence case (Read_orders) breaks the technical accuracy of the documentation.

Suggested change

**10. Read\_orders** **Access Scope:** [Abandoned checkouts](https://shopify.dev/docs/api/admin-rest/latest/resources/abandoned-checkouts), [Customer](https://shopify.dev/docs/api/admin-rest/latest/resources/customer), [Fulfillment](https://shopify.dev/docs/api/admin-rest/latest/resources/fulfillment), [Order](https://shopify.dev/docs/api/admin-rest/latest/resources/order), and [Transaction](https://shopify.dev/docs/api/admin-rest/latest/resources/transaction) resources. **Reason:** HotWax Commerce imports all orders and updates to ensure comprehensive order management and accurate fulfillment processes.

**10. read\_orders** **Access Scope:** [Abandoned checkouts](https://shopify.dev/docs/api/admin-rest/latest/resources/abandoned-checkouts), [Customer](https://shopify.dev/docs/api/admin-rest/latest/resources/customer), [Fulfillment](https://shopify.dev/docs/api/admin-rest/latest/resources/fulfillment), [Order](https://shopify.dev/docs/api/admin-rest/latest/resources/order), and [Transaction](https://shopify.dev/docs/api/admin-rest/latest/resources/transaction) resources. **Reason:** HotWax Commerce imports all orders and updates to ensure comprehensive order management and accurate fulfillment processes.

gemini-code-assist · 2026-05-05T14:03:16Z

 1. To display nearby pickup locations for customers, latitude and longitude coordinates are required. The HotWax Commerce BOPIS PDP app for Shopify obtains these coordinates in two ways:

-* When customers enter their postal code, the HotWax Commerce BOPIS PDP app utilizes the "postcodeLookup" API of HotWax Commerce to convert the postal code into accurate latitude and longitude coordinates.
+* When customers enter their postal code, the HotWax Commerce BOPIS PDP app utilizes the "postcode Lookup" API of HotWax Commerce to convert the postal code into accurate latitude and longitude coordinates.


The API name postcodeLookup has been incorrectly split into postcode Lookup. This breaks the technical reference to the API.

Suggested change

* When customers enter their postal code, the HotWax Commerce BOPIS PDP app utilizes the "postcode Lookup" API of HotWax Commerce to convert the postal code into accurate latitude and longitude coordinates.

* When customers enter their postal code, the HotWax Commerce BOPIS PDP app utilizes the "postcodeLookup" API of HotWax Commerce to convert the postal code into accurate latitude and longitude coordinates.

gemini-code-assist · 2026-05-05T14:03:16Z

 {% hint style="info" %}
 To seamlessly import Kit products into OMS, ensure that the Shopify Config Access Scope is set to grant both read and write access to the Shopify shop.
-{% endhint %}
+{% End hint %}


The GitBook hint block closing tag {% endhint %} has been incorrectly changed to {% End hint %}. This will break the rendering of the hint block.

Suggested change

{% End hint %}

{% endhint %}

gemini-code-assist · 2026-05-05T14:03:16Z

 Omnichannel Shopify retailers offer their customers two different options for returning online products: Mail Returns and In-Store Returns. Let's see how HotWax Commerce helps in handling these two types of returns:

-**Mail Returns:** Mail returns could be initiated by customers, or by the Customer Service Representative (CSR) team in response to customer requests, which can be received through email or phone calls. Returns are created in Shopify and retailers often use third-party return management apps like Happy Returns, Loop Returns, or Returnly to facilitate the management of returns.
+**Mail Returns:** Mail returns could be initiated by customers, or by the Customer Service Representative (CSR) team in response to customer requests, which can be received through email or phone calls. Returns are created in Shopify and retailers often use third-party return management apps like Happy Returns, Loop Returns, or Return to facilitate the management of returns.


Returnly is the name of a specific third-party application. Changing it to Return is incorrect.

Suggested change

**Mail Returns:** Mail returns could be initiated by customers, or by the Customer Service Representative (CSR) team in response to customer requests, which can be received through email or phone calls. Returns are created in Shopify and retailers often use third-party return management apps like Happy Returns, Loop Returns, or Return to facilitate the management of returns.

**Mail Returns:** Mail returns could be initiated by customers, or by the Customer Service Representative (CSR) team in response to customer requests, which can be received through email or phone calls. Returns are created in Shopify and retailers often use third-party return management apps like Happy Returns, Loop Returns, or Returnly to facilitate the management of returns.

gemini-code-assist · 2026-05-05T14:03:16Z

+---D description: Learn how HotWax Commerce updates Kit order fulfillment status to Shopify.
 ---


The YAML front matter is broken by the incorrect modification of the description field.

Suggested change

---D description: Learn how HotWax Commerce updates Kit order fulfillment status to Shopify.

---

---

description: Learn how HotWax Commerce updates Kit order fulfillment status to Shopify.

---

dt2patel

This is not ready to merge. The current diff introduces broken documentation markup in multiple places, including invalid attribute/tag changes like mapped Value, <try>, <the>, and ref in place of href. Please fix the broken markup before another merge pass.

rachitaarsh-jpg · 2026-05-06T06:12:00Z

Okay, Sir, I will now start the fix.

…

On Wed, May 6, 2026 at 11:34 AM Aditya Patel ***@***.***> wrote: ***@***.**** requested changes on this pull request. This is not ready to merge. The current diff introduces broken documentation markup in multiple places, including invalid attribute/tag changes like mapped Value, <try>, <the>, and ref in place of href. Please fix the broken markup before another merge pass. — Reply to this email directly, view it on GitHub <#1688 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/CBE5VCESGBTSQBVV37MQBUL4ZLIYNAVCNFSM6AAAAACYRURVPOVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHM2DEMZTGYYTGOBRGI> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you authored the thread.Message ID: ***@***.***>

…tical errors in learn-shopify doc

Fix typos and broken links in learn-shopify documentation

07f87f1

gemini-code-assist Bot reviewed May 5, 2026

View reviewed changes

dt2patel requested changes May 6, 2026

View reviewed changes

rachitaarsh-jpg added 2 commits May 6, 2026 13:42

Rectified the changes to avoid broken links and fixed typos and grama…

7c22b24

…tical errors in learn-shopify doc

Final Fixes in learn-shopify docs

caa6ab4

rachitaarsh-jpg requested a review from dt2patel May 6, 2026 09:07

minor tweaks done

c28a778

	<ShopifyShopTypeMapping mappedKey="{Shopify Kit Type}" mappedTypeId="SHOPIFY_PRODUCT_TYPE" mapped Value="MARKETING_PKG_PICK" shopId="SHOP"/>
	<ShopifyShopTypeMapping mappedKey="{Shopify Kit Type}" mappedTypeId="SHOPIFY_PRODUCT_TYPE" mappedValue="MARKETING_PKG_PICK" shopId="SHOP"/>

	> https://admin.shopify.com/admin/{shop-name}/products/count.json https://admin.shopify.com/admin/{shop-name}/variants/count.Jason
	> https://admin.shopify.com/admin/{shop-name}/products/count.json https://admin.shopify.com/admin/{shop-name}/variants/count.json

	To retrieve counts in HotWax, follow these structured steps in the webtoons:
	To retrieve counts in HotWax, follow these structured steps in the webtools:

	* When customers enter their postal code, the HotWax Commerce BOPIS PDP app utilizes the "postcode Lookup" API of HotWax Commerce to convert the postal code into accurate latitude and longitude coordinates.
	* When customers enter their postal code, the HotWax Commerce BOPIS PDP app utilizes the "postcodeLookup" API of HotWax Commerce to convert the postal code into accurate latitude and longitude coordinates.

	Mail Returns: Mail returns could be initiated by customers, or by the Customer Service Representative (CSR) team in response to customer requests, which can be received through email or phone calls. Returns are created in Shopify and retailers often use third-party return management apps like Happy Returns, Loop Returns, or Return to facilitate the management of returns.
	Mail Returns: Mail returns could be initiated by customers, or by the Customer Service Representative (CSR) team in response to customer requests, which can be received through email or phone calls. Returns are created in Shopify and retailers often use third-party return management apps like Happy Returns, Loop Returns, or Returnly to facilitate the management of returns.

		---D description: Learn how HotWax Commerce updates Kit order fulfillment status to Shopify.
		---

Conversation

rachitaarsh-jpg commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot May 5, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 5, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 5, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 5, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 5, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 5, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 5, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 5, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 5, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 5, 2026

Choose a reason for hiding this comment

Uh oh!

dt2patel left a comment

Choose a reason for hiding this comment

Uh oh!

rachitaarsh-jpg commented May 6, 2026 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rachitaarsh-jpg commented May 5, 2026 •

edited

Loading