Inventory
The input fields required to adjust inventory quantities.
Anchor to FieldsFields
- Anchor to changeschanges•[Inventory
Change Input!]! required The quantity changes of items at locations to be made.
- Anchor to namename•String!non-null
The quantity name to be adjusted.
- Anchor to reasonreason•String!non-null
The reason for the quantity changes. The value must be one of the possible reasons.
- Anchor to referenceDocumentUrireference•String
Document Uri A URI that represents why the inventory change happened, identifying the source system and document that caused this adjustment. Enables complete audit trails and brand visibility in Shopify admin inventory history.
Preferred format - Global ID (GID): gid://[your-app-name]/[entity-type]/[id]
Examples:
- gid://warehouse-app/PurchaseOrder/PO-2024-001 (stock received)
- gid://3pl-system/CycleCount/CC-2024-0125 (cycle count adjustment)
- gid://pos-app/Transaction/TXN-98765 (in-store sale)
- gid://erp-connector/SyncJob/SYNC-2024-11-21-001 (ERP sync)
- gid://shopify/Order/1234567890 (Shopify order reference)
Benefits: Your app name appears directly in merchant inventory history, reducing support tickets and providing clear audit trails for compliance.
Alternative formats (also supported): https://myapp.com/documents/12345, custom-scheme://identifier
Requirements: Valid URI with scheme and content. For GID format, all components (app, entity, id) must be present.