Add support for syncing the "Mark as Sold Out" field value during inventory sync.

[iamdharmesh]

All Submissions:

• Does your code follow the WooCommerce Sniffs variant of WordPress coding standards?
• Have you written new tests for your changes, as applicable?
• Have you successfully run tests with your changes locally?
• Will this change require new documentation or changes to existing documentation?

---

Changes proposed in this Pull Request:

As mentioned in #21, on the Square side, we can mark an inventory-tracking-disabled product as "Out of Stock" using the "Mark as Sold Out on Point of Sale and Online" option. However, currently, when inventory tracking is disabled for a product in Square, it always updates the stock status to "In Stock," regardless of the value of the sold_out field.

This PR adds support for the sold_out field, ensuring it is considered during inventory sync and updating the stock status to "Out of Stock" whenever a product is marked as sold on the Square side while inventory tracking is disabled.

Notes

• The sold_out field is read-only, so using API we can't mark Square products as sold out while keeping inventory tracking disabled. The closest alternative is to mark the product as sold out with inventory tracking enabled. This means enabling inventory tracking and setting the stock value to 0, which will reflect on the WooCommerce side as well since stock levels are pulled from Square during inventory sync.
  

• When we mark an item as sold out, Square allows us to set a time for it to become available again. At that time, it will automatically be marked as in stock. I didn’t add support for this in this PR, as we already have a sync running every 15 minutes (interval polling). The product will become available within 15 minutes once it is marked as available on the Square side, which I think is acceptable. @dkotter, please let me know if you think we should sync this in real time. We could schedule an Action Scheduler task for the specific availability time, but if the number of products is high, this would increase the number of scheduled actions. Since 15 minutes is a relatively short interval, it should be fine for now. However, we can consider implementing real-time syncing if we receive customer requests for it.
  

Closes #21

Steps to test the changes in this Pull Request:

Square SOR:

1. Create a product in the Square Dashboard with inventory tracking disabled and marked as "Sold out."
2. Click "Import Products" from the Square settings in the WordPress admin.
3. Verify that the product is imported successfully with "Manage stock" disabled and the stock status set to "Out of stock."
4. Go to the Square Dashboard and make the product available.
5. Go to WooCommerce > Settings > Square > Update. Click the Sync button and wait for the sync process to complete.
6. Verify that the product is updated successfully on the WooCommerce side and that the stock status is now "In stock."
7. Go to the Square Dashboard again and mark the product as sold out. Wait for 15 minutes or trigger an interval polling sync from Tools > Scheduled Actions by manually running the wc_square_sync action.
8. Verify that the product's stock status has been updated to "Out of stock."
9. In the Square Dashboard, set time to make a product for sale again to the future time (2–3 minutes ahead). Once the product becomes available in Square, wait for 15 minutes or manually trigger an interval poll sync.
10. Verify that the product's stock status has been updated to "In stock."

Woo SOR:

1. Create a product in WooCommerce with "Manage stock" disabled and the stock status set to "Out of stock."
2. Verify that the product is created on the Square side with inventory tracking enabled and stock set to 0.
3. Follow steps 3 to 10 from Square SOR and ensure the sync works as expected.

Changelog entry

Add - Support for syncing the "Mark as Sold Out" field value during inventory sync.

[dkotter]

The product will become available within 15 minutes once it is marked as available on the Square side, which I think is acceptable. @dkotter, please let me know if you think we should sync this in real time. We could schedule an Action Scheduler task for the specific availability time, but if the number of products is high, this would increase the number of scheduled actions. Since 15 minutes is a relatively short interval, it should be fine for now. However, we can consider implementing real-time syncing if we receive customer requests for it

I think I agree, this is fine for the initial implementation as long as we document this. If we get customer requests to change this, we can look into that at that point

[qasumitbagthariya]

QA Update ✅

---

I have verified this PR in the enhancement/21 branch which has been fixed and is functioning as intended.

I tested the following on this branch:

• Sync with Square and Woo SOR
• Out of stock / In stock Seanario

Square_step1_out.of.stock.mov

Step-2In.stock.mov

Step-3.sold.out.-.run.event.mov

Future.Time.in.Square.1.mov

Note: I've record a testing videos for Square - SOR

Testing Environment

• WordPress: 6.7.1
• Theme: Twenty Twenty-Four 1.3
• WooCommerce - 9.6.1
• PHP: 8.0.30
• Web Server: Nginx 1.20.2
• Browser: Chrome
• OS: macOS 15.2
• Branch: enhancement/21

Steps to Test- As mentioned in the PR description.
Test Results - It is working as expected.
Functional Demo / Screencast -
Special Notes - Ready for code review (Woo)
Testing Document status:
Cases related to this Issue/PR are added to the Critical Flow Wiki pages:

• Yes - Pending
• Not Required/Applicable for this PR

---