Enhanced Guidelines for `referenceDocumentUri` in Inventory Adjustments

Enhanced Guidelines for `referenceDocumentUri` in Inventory Adjustments

Shopify Updates: 

Introduction

We're excited to announce updated guidelines and detailed documentation for the referenceDocumentUri field in inventory adjustment mutations. These guidelines are designed to help Shopify app developers streamline inventory traceability, enabling merchants to troubleshoot issues and conduct audits more easily.

Key Updates

Detailed Guidelines

  • Link each inventory adjustment to its source system and document using the referenceDocumentUri field.
  • Adopt the Global ID (GID) format (gid://namespace/entity/id) for consistent integration across systems.
  • Support multiple URI formats, including URLs and custom schemes, ensuring backward compatibility.

Best Practices

  • Define namespaces and entity types clearly to avoid confusion.
  • Follow the provided code examples for Warehouse Management Systems (WMS), Third-Party Logistics (3PL), Point of Sale (POS), and Enterprise Resource Planning (ERP) integrations.

Migration Guides and Validation Rules

  • Upgrade existing implementations easily with step-by-step migration guides.
  • Ensure compliance with validation rules and format specifications.

Benefits for Merchants

  • Enable comprehensive audit trails to uphold compliance and accountability.
  • Display app names within Shopify admin inventory history for better visibility.
  • Simplify troubleshooting by tracing inventory changes back to their origin.

Getting Started

To implement these updates, incorporate the referenceDocumentUri field into the inventoryAdjustQuantities mutation. Explore the updated guidelines and documentation for more details.

Back to blog