New guidelines for referenceDocumentUri in inventory adjustments

We've released new guidelines and updated documentation for the referenceDocumentUri field in inventory adjustment mutations. By following these guidelines, your apps can maintain inventory traceability, which helps merchants troubleshoot issues and conduct audits more easily. Access the field in admin via the "Inventory adjustment changes" report in Analytics or on the Adjustment History Page.

What’s new:

• Detailed guidelines for using the referenceDocumentUri field to link each inventory adjustment to its source system and document.
• Recommendations for adopting the Global ID (GID) format (gid://namespace/entity/id) to maintain consistency across integrations.
• Support for various URI formats, including URLs and custom schemes, ensuring backward compatibility.
• Best practices for defining namespaces and entity types.
• Code examples for Warehouse Management Systems (WMS), Third-Party Logistics (3PL), Point of Sale (POS), and Enterprise Resource Planning (ERP) integrations.
• Migration guides for updating existing implementations.
• Validation rules and format specifications.

These updates enable you to:

• Provide merchants with comprehensive audit trails for compliance.
• Display your app’s name in Shopify admin inventory history.
• Trace inventory changes back to their origin, simplifying troubleshooting.

To implement, you'll incorporate the referenceDocumentUri field into the inventoryAdjustQuantities mutation.

Explore the updated guidelines and documentation