{"id":"9f878bed-cfc7-4d18-8843-4ed16bdac26c","createdDate":"2024-06-18T12:10:18.354Z","updatedDate":"2024-06-18T12:10:18.354Z","resourceId":"449d21d9-7cf3-439f-a403-6d13a51f78cb","api":{"schema":{"object":{"displayName":"Inventory Object","description":"","slug":"inventory-object","$ref":"#/components/schemas/wix.inventory.api.v1.InventoryItemV2","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Get Inventory Variants","description":"","operationId":"wix.inventory.api.v1.InventoryReadApi.GetInventoryVariants","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.inventory.api.v1.GetInventoryVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores-reader/v2/inventoryItems","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores-reader/v2/inventoryItems","destinationPath":"/v2/inventoryItems","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"GetInventoryVariantsRequest","description":"","properties":{"variantIds":{"description":"Variant IDs to query for this inventory item (optional).","title":"variantIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/wix.inventory.api.v1.GetInventoryVariantsRequest.id"}],"required":["inventoryId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.inventory.api.v1.InventoryReadApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.READ_INVENTORY"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-inventory-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-reader-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.inventory.api.v1.GetInventoryVariantsRequest","responseMessage":"wix.inventory.api.v1.GetInventoryVariantsResponse"},"legacyExamples":[{"name":"GetInventoryVariants","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST https://www.wixapis.com/stores/v2/inventoryItems/be547028-fb08-b962-75e8-3f3e56da9ee3/getVariants \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {}\n }'\n~~~","response":"~~~json\n{\n \"inventoryItem\": {\n \"id\": \"b22b2a79-52b3-e8e2-721e-1779a82dc414\",\n \"externalId\": \"4dd4d586-ad4c-171d-8de1-e88657d23beb\",\n \"productId\": \"4dd4d586-ad4c-171d-8de1-e88657d23beb\",\n \"trackQuantity\": false,\n \"variants\": [\n {\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"inStock\": false,\n \"quantity\": 0,\n \"availableForPreorder\": true\n }\n ],\n \"lastUpdated\": \"2022-11-24T15:10:55.789Z\",\n \"numericId\": \"1669215583914000\",\n \"preorderInfo\": {\n \"enabled\": true,\n \"message\": \"Expected to ship on June\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/inventoryItems/{inventoryId}/getVariants","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.inventory.api.v1.InventoryReadApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.READ_INVENTORY"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-inventory-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-reader-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.inventory.api.v1.GetInventoryVariantsRequest","responseMessage":"wix.inventory.api.v1.GetInventoryVariantsResponse"},"legacyExamples":[{"name":"GetInventoryVariants","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST https://www.wixapis.com/stores/v2/inventoryItems/be547028-fb08-b962-75e8-3f3e56da9ee3/getVariants \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {}\n }'\n~~~","response":"~~~json\n{\n \"inventoryItem\": {\n \"id\": \"b22b2a79-52b3-e8e2-721e-1779a82dc414\",\n \"externalId\": \"4dd4d586-ad4c-171d-8de1-e88657d23beb\",\n \"productId\": \"4dd4d586-ad4c-171d-8de1-e88657d23beb\",\n \"trackQuantity\": false,\n \"variants\": [\n {\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"inStock\": false,\n \"quantity\": 0,\n \"availableForPreorder\": true\n }\n ],\n \"lastUpdated\": \"2022-11-24T15:10:55.789Z\",\n \"numericId\": \"1669215583914000\",\n \"preorderInfo\": {\n \"enabled\": true,\n \"message\": \"Expected to ship on June\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Inventory Variants","slugifiedName":"get-inventory-variants"}},{"summary":"Query Inventory","description":"Returns a list of up inventory items, given the provided paging, sorting and filtering.\nSee [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.","operationId":"wix.inventory.api.v1.InventoryReadApi.QueryInventory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.inventory.api.v1.QueryInventoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores-reader/v2/inventoryItems","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores-reader/v2/inventoryItems","destinationPath":"/v2/inventoryItems","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryInventoryRequest","description":"","properties":{"query":{"description":"","$ref":"#/components/schemas/wix.inventory.api.v1.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.inventory.api.v1.InventoryReadApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.READ_INVENTORY"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-inventory-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-reader-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.inventory.api.v1.QueryInventoryRequest","responseMessage":"wix.inventory.api.v1.QueryInventoryResponse"},"legacyExamples":[{"name":"QueryInventory","type":"METHOD","order":2,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST https://www.wixapis.com/stores/v2/inventoryItems/query \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"filter\": \"{\\\"lastUpdated\\\": {\\\"$gt\\\": [\\\"2020-01-29T09:22:00.000Z\\\"]}}\"\n }\n }\n }'\n~~~","response":"~~~json\n{\n \"inventoryItems\": [\n {\n \"id\": \"37ac6499-85bb-01e7-5003-5013b417a9d5\",\n \"externalId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\",\n \"productId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\",\n \"trackQuantity\": true,\n \"variants\": [\n {\n \"variantId\": \"d54efb4b-4377-4cfa-8c24-4312fd946f97\",\n \"inStock\": false,\n \"quantity\": 0,\n \"availableForPreorder\": true\n },\n {\n \"variantId\": \"99fe8f89-d3a3-4b13-aa03-ba756e93e4a1\",\n \"inStock\": false,\n \"quantity\": 0,\n \"availableForPreorder\": true\n },\n {\n \"variantId\": \"f56a93d2-e579-4ec1-bdc4-1cefec096d75\",\n \"inStock\": true,\n \"quantity\": 2\n }\n ],\n \"lastUpdated\": \"2022-08-24T13:59:51.196Z\",\n \"numericId\": \"1462356020245000\",\n \"preorderInfo\": {\n \"enabled\": true,\n \"message\": \"zX\",\n \"limit\": 15\n }\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 1\n}\n~~~"}},{"name":"QueryInventory","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST https://www.wixapis.com/stores/v2/inventoryItems/query \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {}\n }'\n~~~","response":"~~~json\n{\n \"inventoryItems\": [\n {\n \"id\": \"b22b2a79-52b3-e8e2-721e-1779a82dc414\",\n \"externalId\": \"4dd4d586-ad4c-171d-8de1-e88657d23beb\",\n \"productId\": \"4dd4d586-ad4c-171d-8de1-e88657d23beb\",\n \"trackQuantity\": false,\n \"variants\": [\n {\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"inStock\": false,\n \"quantity\": 0,\n \"availableForPreorder\": true\n }\n ],\n \"lastUpdated\": \"2022-11-24T15:10:55.789Z\",\n \"numericId\": \"1669215583914000\",\n \"preorderInfo\": {\n \"enabled\": true,\n \"message\": \"Expected to ship on June\"\n }\n },\n {\n \"id\": \"a420a4c4-4b88-13c1-c970-6eef58fb7985\",\n \"externalId\": \"5bdf5b3b-b477-ec3e-368f-9110a704867a\",\n \"productId\": \"5bdf5b3b-b477-ec3e-368f-9110a704867a\",\n \"trackQuantity\": true,\n \"variants\": [\n {\n \"variantId\": \"da6fbb9d-c65d-4908-8108-d2f99f216921\",\n \"inStock\": false\n },\n {\n \"variantId\": \"a0e8bd24-546f-46ee-83a4-5d24513b4133\",\n \"inStock\": false,\n \"quantity\": -1\n },\n {\n \"variantId\": \"4d612768-c53b-4dc8-9fb5-066a8699d930\",\n \"inStock\": true,\n \"quantity\": 2\n },\n {\n \"variantId\": \"1acc8160-81bd-45ce-b31f-4e62c918872c\",\n \"inStock\": false\n }\n ],\n \"lastUpdated\": \"2022-11-21T14:04:26.977Z\",\n \"numericId\": \"1669039466977000\",\n \"preorderInfo\": {}\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 2\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/inventoryItems/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.inventory.api.v1.InventoryReadApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.READ_INVENTORY"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-inventory-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-reader-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.inventory.api.v1.QueryInventoryRequest","responseMessage":"wix.inventory.api.v1.QueryInventoryResponse"},"legacyExamples":[{"name":"QueryInventory","type":"METHOD","order":2,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST https://www.wixapis.com/stores/v2/inventoryItems/query \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"filter\": \"{\\\"lastUpdated\\\": {\\\"$gt\\\": [\\\"2020-01-29T09:22:00.000Z\\\"]}}\"\n }\n }\n }'\n~~~","response":"~~~json\n{\n \"inventoryItems\": [\n {\n \"id\": \"37ac6499-85bb-01e7-5003-5013b417a9d5\",\n \"externalId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\",\n \"productId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\",\n \"trackQuantity\": true,\n \"variants\": [\n {\n \"variantId\": \"d54efb4b-4377-4cfa-8c24-4312fd946f97\",\n \"inStock\": false,\n \"quantity\": 0,\n \"availableForPreorder\": true\n },\n {\n \"variantId\": \"99fe8f89-d3a3-4b13-aa03-ba756e93e4a1\",\n \"inStock\": false,\n \"quantity\": 0,\n \"availableForPreorder\": true\n },\n {\n \"variantId\": \"f56a93d2-e579-4ec1-bdc4-1cefec096d75\",\n \"inStock\": true,\n \"quantity\": 2\n }\n ],\n \"lastUpdated\": \"2022-08-24T13:59:51.196Z\",\n \"numericId\": \"1462356020245000\",\n \"preorderInfo\": {\n \"enabled\": true,\n \"message\": \"zX\",\n \"limit\": 15\n }\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 1\n}\n~~~"}},{"name":"QueryInventory","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST https://www.wixapis.com/stores/v2/inventoryItems/query \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {}\n }'\n~~~","response":"~~~json\n{\n \"inventoryItems\": [\n {\n \"id\": \"b22b2a79-52b3-e8e2-721e-1779a82dc414\",\n \"externalId\": \"4dd4d586-ad4c-171d-8de1-e88657d23beb\",\n \"productId\": \"4dd4d586-ad4c-171d-8de1-e88657d23beb\",\n \"trackQuantity\": false,\n \"variants\": [\n {\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"inStock\": false,\n \"quantity\": 0,\n \"availableForPreorder\": true\n }\n ],\n \"lastUpdated\": \"2022-11-24T15:10:55.789Z\",\n \"numericId\": \"1669215583914000\",\n \"preorderInfo\": {\n \"enabled\": true,\n \"message\": \"Expected to ship on June\"\n }\n },\n {\n \"id\": \"a420a4c4-4b88-13c1-c970-6eef58fb7985\",\n \"externalId\": \"5bdf5b3b-b477-ec3e-368f-9110a704867a\",\n \"productId\": \"5bdf5b3b-b477-ec3e-368f-9110a704867a\",\n \"trackQuantity\": true,\n \"variants\": [\n {\n \"variantId\": \"da6fbb9d-c65d-4908-8108-d2f99f216921\",\n \"inStock\": false\n },\n {\n \"variantId\": \"a0e8bd24-546f-46ee-83a4-5d24513b4133\",\n \"inStock\": false,\n \"quantity\": -1\n },\n {\n \"variantId\": \"4d612768-c53b-4dc8-9fb5-066a8699d930\",\n \"inStock\": true,\n \"quantity\": 2\n },\n {\n \"variantId\": \"1acc8160-81bd-45ce-b31f-4e62c918872c\",\n \"inStock\": false\n }\n ],\n \"lastUpdated\": \"2022-11-21T14:04:26.977Z\",\n \"numericId\": \"1669039466977000\",\n \"preorderInfo\": {}\n }\n ],\n \"metadata\": {\n \"items\": 100,\n \"offset\": 0\n },\n \"totalResults\": 2\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Inventory","slugifiedName":"query-inventory"}},{"summary":"Update Inventory Variants","description":"Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.","operationId":"wix.inventory.api.v1.InventoryWriteApi.UpdateInventoryVariants","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"inventoryItem.productId","description":"Product ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.inventory.api.v1.UpdateInventoryVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v2/inventoryItems","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/inventoryItems","destinationPath":"/v2/inventoryItems","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateInventoryVariantsRequest","description":"","properties":{"inventoryItem":{"description":"Inventory item.","$ref":"#/components/schemas/wix.inventory.api.v1.InventoryItemV2","summary":"inventoryItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["inventoryItem","inventoryItem.productId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.inventory.api.v1.InventoryWriteApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.MODIFY_INVENTORY"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-inventory-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.inventory.api.v1.UpdateInventoryVariantsRequest","responseMessage":"wix.inventory.api.v1.UpdateInventoryVariantsResponse"},"legacyExamples":[{"name":"UpdateInventoryVariants","type":"METHOD","order":3,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH https://www.wixapis.com/stores/v2/inventoryItems/0ff8f8b0-2857-5974-193e-8283c21fde00 \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {\n \t\"inventoryItem\": {\n \t\t\"trackQuantity\": false,\n \t\t\"variants\": [\n {\n \"variantId\": \"00000000-0000-0001-0005-9a596c8e6f10\",\n \"inStock\": true\n },\n {\n \"variantId\": \"00000000-0000-0002-0005-9a596c8e6f10\",\n \"inStock\": true\n }\n \t\t],\n \"numericId\": 0,\n \"preorderInfo\": {\n \"enabled\": true,\n \"limit\": 6,\n \"message\": \"Expected to ship on June\"\n }\n \t}\n }'\n~~~","response":"~~~json\n{}\n~~~"}},{"name":"UpdateInventoryVariants","type":"METHOD","order":2,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH https://www.wixapis.com/stores/v2/inventoryItems/0ff8f8b0-2857-5974-193e-8283c21fde00 \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {\n \t\"inventoryItem\": {\n \t\t\"trackQuantity\": false,\n \t\t\"variants\": [\n \t\t\t{\n \t\t\t\t\"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \t\t\t\t\"inStock\": false\n \t\t\t}\n \t\t],\n \"numericId\": 0,\n \"preorderInfo\": {\n \"enabled\": true,\n \"limit\": 6,\n \"message\": \"Expected to ship on June\"\n }\n \t}\n }'\n~~~","response":"~~~json\n{}\n~~~"}},{"name":"UpdateInventoryVariants","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH https://www.wixapis.com/stores/v2/inventoryItems/0ff8f8b0-2857-5974-193e-8283c21fde00 \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {\n \t\"inventoryItem\": {\n \t\t\"trackQuantity\": true,\n \t\t\"variants\": [\n \t\t\t{\n \t\t\t\t\"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \t\t\t\t\"quantity\": 1\n \t\t\t}\n \t\t],\n \"numericId\": 0,\n \"preorderInfo\": {\n \"enabled\": true,\n \"limit\": 4,\n \"message\": \"Expected to ship on June\"\n }\n \t}\n }'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v2/inventoryItems/product/{inventoryItem.productId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.inventory.api.v1.InventoryWriteApi","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_STORES.MODIFY_INVENTORY"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-inventory-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.inventory.api.v1.UpdateInventoryVariantsRequest","responseMessage":"wix.inventory.api.v1.UpdateInventoryVariantsResponse"},"legacyExamples":[{"name":"UpdateInventoryVariants","type":"METHOD","order":3,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH https://www.wixapis.com/stores/v2/inventoryItems/0ff8f8b0-2857-5974-193e-8283c21fde00 \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {\n \t\"inventoryItem\": {\n \t\t\"trackQuantity\": false,\n \t\t\"variants\": [\n {\n \"variantId\": \"00000000-0000-0001-0005-9a596c8e6f10\",\n \"inStock\": true\n },\n {\n \"variantId\": \"00000000-0000-0002-0005-9a596c8e6f10\",\n \"inStock\": true\n }\n \t\t],\n \"numericId\": 0,\n \"preorderInfo\": {\n \"enabled\": true,\n \"limit\": 6,\n \"message\": \"Expected to ship on June\"\n }\n \t}\n }'\n~~~","response":"~~~json\n{}\n~~~"}},{"name":"UpdateInventoryVariants","type":"METHOD","order":2,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH https://www.wixapis.com/stores/v2/inventoryItems/0ff8f8b0-2857-5974-193e-8283c21fde00 \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {\n \t\"inventoryItem\": {\n \t\t\"trackQuantity\": false,\n \t\t\"variants\": [\n \t\t\t{\n \t\t\t\t\"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \t\t\t\t\"inStock\": false\n \t\t\t}\n \t\t],\n \"numericId\": 0,\n \"preorderInfo\": {\n \"enabled\": true,\n \"limit\": 6,\n \"message\": \"Expected to ship on June\"\n }\n \t}\n }'\n~~~","response":"~~~json\n{}\n~~~"}},{"name":"UpdateInventoryVariants","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH https://www.wixapis.com/stores/v2/inventoryItems/0ff8f8b0-2857-5974-193e-8283c21fde00 \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {\n \t\"inventoryItem\": {\n \t\t\"trackQuantity\": true,\n \t\t\"variants\": [\n \t\t\t{\n \t\t\t\t\"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \t\t\t\t\"quantity\": 1\n \t\t\t}\n \t\t],\n \"numericId\": 0,\n \"preorderInfo\": {\n \"enabled\": true,\n \"limit\": 4,\n \"message\": \"Expected to ship on June\"\n }\n \t}\n }'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Inventory Variants","slugifiedName":"update-inventory-variants"}},{"summary":"Decrement Inventory","description":"Subtracts a set number of items from inventory.","operationId":"wix.inventory.api.v1.InventoryWriteApi.DecrementInventory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.inventory.api.v1.DecrementInventoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v2/inventoryItems","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/inventoryItems","destinationPath":"/v2/inventoryItems","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"DecrementInventoryRequest","description":"","properties":{"decrementData":{"description":"","minItems":1,"maxItems":300,"title":"decrementData","type":"array","items":{"$ref":"#/components/schemas/wix.inventory.api.v1.DecrementData"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.inventory.api.v1.InventoryWriteApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.MODIFY_INVENTORY"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-inventory-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.inventory.api.v1.DecrementInventoryRequest","responseMessage":"wix.inventory.api.v1.DecrementInventoryResponse"},"legacyExamples":[{"name":"DecrementInventory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST https://www.wixapis.com/stores/v2/inventoryItems/decrement \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {\n \"decrementData\": [\n {\n \"productId\": \"f007074f-d7a8-a68b-e6c1-7d7c3de021ff\",\n \"variantId\": \"00000000-0000-0001-0005-9ccb19c4e6f0\",\n \"decrementBy\": 2\n }\n ]\n }'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/inventoryItems/decrement","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.inventory.api.v1.InventoryWriteApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.MODIFY_INVENTORY"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-inventory-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.inventory.api.v1.DecrementInventoryRequest","responseMessage":"wix.inventory.api.v1.DecrementInventoryResponse"},"legacyExamples":[{"name":"DecrementInventory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST https://www.wixapis.com/stores/v2/inventoryItems/decrement \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {\n \"decrementData\": [\n {\n \"productId\": \"f007074f-d7a8-a68b-e6c1-7d7c3de021ff\",\n \"variantId\": \"00000000-0000-0001-0005-9ccb19c4e6f0\",\n \"decrementBy\": 2\n }\n ]\n }'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Decrement Inventory","slugifiedName":"decrement-inventory"}},{"summary":"Increment Inventory","description":"Adds a set number of items to inventory.","operationId":"wix.inventory.api.v1.InventoryWriteApi.IncrementInventory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.inventory.api.v1.IncrementInventoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v2/inventoryItems","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/inventoryItems","destinationPath":"/v2/inventoryItems","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"IncrementInventoryRequest","description":"","properties":{"incrementData":{"description":"","minItems":1,"maxItems":300,"title":"incrementData","type":"array","items":{"$ref":"#/components/schemas/wix.inventory.api.v1.IncrementData"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.inventory.api.v1.InventoryWriteApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.MODIFY_INVENTORY"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-inventory-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.inventory.api.v1.IncrementInventoryRequest","responseMessage":"wix.inventory.api.v1.IncrementInventoryResponse"},"legacyExamples":[{"name":"IncrementInventory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST https://www.wixapis.com/stores/v2/inventoryItems/increment \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {\n \"incrementData\": [\n {\n \"productId\": \"f007074f-d7a8-a68b-e6c1-7d7c3de021ff\",\n \"variantId\": \"00000000-0000-0001-0005-9ccb19c4e6f0\",\n \"incrementBy\": 2\n }\n ]\n }'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/inventoryItems/increment","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.inventory.api.v1.InventoryWriteApi","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.MODIFY_INVENTORY"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-inventory-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-catalog-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.inventory.api.v1.IncrementInventoryRequest","responseMessage":"wix.inventory.api.v1.IncrementInventoryResponse"},"legacyExamples":[{"name":"IncrementInventory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST https://www.wixapis.com/stores/v2/inventoryItems/increment \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '\n {\n \"incrementData\": [\n {\n \"productId\": \"f007074f-d7a8-a68b-e6c1-7d7c3de021ff\",\n \"variantId\": \"00000000-0000-0001-0005-9ccb19c4e6f0\",\n \"incrementBy\": 2\n }\n ]\n }'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Increment Inventory","slugifiedName":"increment-inventory"}}],"webhooks":[{"summary":"Inventory Inventory Item Changed","title":"Inventory Inventory Item Changed","description":"Triggered when an inventory item is changed.","permissions":["WIX_STORES.READ_INVENTORY"],"payload":{"schemaName":"com.wix.ecommerce.inventory.api.v1.InventoryItemChanged"},"exposure":"PUBLIC","maturity":"GA","slug":"inventory_item_changed","eventTopic":"wixStores-inventory-item-changed","serviceName":"wix.inventory.api.v1.InventoryReadApi","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"}],"eventType":"com.wix.ecommerce.inventory.api.v1.InventoryItemChanged","legacyExamples":[{"name":"Inventory Item Changed","type":"LEGACY_EVENT","content":"{\n \"inventoryItemId\": \"81b0fdc0-ac2d-8f25-cf44-ce99d4c3f6a0\",\n \"externalId\": \"7e4f023f-53d2-70da-30bb-31662b3c095f\",\n \"productId\": \"7e4f023f-53d2-70da-30bb-31662b3c095f\",\n \"trackInventory\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.ecommerce.inventory.api.v1.InventoryItemChanged","contentLink":{"displayName":"Inventory Item Changed","slugifiedName":"inventory-item-changed"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Inventory Inventory Variants Changed","title":"Inventory Inventory Variants Changed","description":"Triggered when inventory variants are changed.","permissions":["WIX_STORES.READ_INVENTORY"],"payload":{"schemaName":"com.wix.ecommerce.inventory.api.v1.InventoryVariantsChanged"},"exposure":"PUBLIC","maturity":"GA","slug":"inventory_variants_changed","eventTopic":"wixStores-inventory-variant-changed","serviceName":"wix.inventory.api.v1.InventoryReadApi","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"}],"eventType":"com.wix.ecommerce.inventory.api.v1.InventoryVariantsChanged","legacyExamples":[{"name":"Inventory Variants Changed","type":"LEGACY_EVENT","content":"{\n \"inventoryItemId\": \"81b0fdc0-ac2d-8f25-cf44-ce99d4c3f6a0\",\n \"externalId\": \"7e4f023f-53d2-70da-30bb-31662b3c095f\",\n \"productId\": \"7e4f023f-53d2-70da-30bb-31662b3c095f\",\n \"variants\": [\n {\n \"id\": \"00000000-0000-0001-0005-918e4641acb0\",\n \"oldValue\": { \"inStock\": true },\n \"newValue\": { \"inStock\": false }\n },\n {\n \"id\": \"00000000-0000-0003-0005-918e4641acb0\",\n \"oldValue\": { \"inStock\": true },\n \"newValue\": { \"inStock\": false }\n }\n ]\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.ecommerce.inventory.api.v1.InventoryVariantsChanged","contentLink":{"displayName":"Inventory Variants Changed","slugifiedName":"inventory-variants-changed"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Inventory API\n\nThis service allows you to query and modify the inventory for your store's products.\n\n(In the future, this service might be used to manage inventory for other things.)\n\n## Terminology\n- **Item** Represents a product from the catalog.\n- **Variant** A product variant. The inventory is managed per variant.\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/intro.md"},{"displayName":"Using the Inventory API","slugifyName":"using-the-inventory-api","content":"# Using the Inventory API\n\n## Step 1 - Query product variants ([Get Inventory Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::449d21d9-7cf3-439f-a403-6d13a51f78cbslug::get-inventory-variants*fallback::https://dev.wix.com/api/rest/wix-stores/inventory/get-inventory-variants) endpoint)\n\n```\ncurl 'https://www.wixapis.com/stores/v2/inventoryItems/product/{productId}/getVariants' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```\n\nFrom the result, you can see whether inventory is being tracked for this product:\n```json\n{\n \"inventoryItem\": {\n \"id\": \"f8753103-0b3a-b24a-4931-50de280ac31a\",\n \"externalId\": \"078acefc-f4c5-4db5-b6ce-af21d7f53ce5\",\n \"productId\": \"078acefc-f4c5-4db5-b6ce-af21d7f53ce5\",\n \"trackQuantity\": true,\n \"variants\": [\n {\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"inStock\": true,\n \"quantity\": 4\n }\n ],\n \"lastUpdated\": \"2020-08-31T20:05:40.348Z\",\n \"numericId\": \"1598904314932014\"\n }\n}\n```\n\n## Step 2 - Update a specific variant of a product ([Update Inventory Status](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::449d21d9-7cf3-439f-a403-6d13a51f78cbslug::update-inventory-variants*fallback::https://dev.wix.com/api/rest/wix-stores/inventory/update-inventory-variants) endpoint)\n\nUpdate whether the product inventory is tracked:\n```\ncurl 'https://www.wixapis.com/stores/v2/inventoryItems/product/{productId}' -X PATCH --data-binary '{\"inventoryItem\": {\"trackQuantity\": false}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```\n\nFor a non-tracked product, you should update inStock:\n```\ncurl 'https://www.wixapis.com/stores/v2/inventoryItems/product/{productId}' -X PATCH --data-binary '{\"inventoryItem\": {\"trackQuantity\": false,\"variants\": [{\"variantId\": \"00000000-0000-0000-0000-000000000000\",\"inStock\": false}]}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```\n\nFor tracked products, you should update quantity:\n```\ncurl 'https://www.wixapis.com/stores/v2/inventoryItems/product/{productId}' -X PATCH --data-binary '{\"inventoryItem\": {\"trackQuantity\": true,\"variants\": [{\"variantId\": \"00000000-0000-0000-0000-000000000000\",\"quantity\": 4}]}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/howToUse.md"}],"components":{"schemas":{"wix.inventory.api.v1.InventoryItemV2":{"type":"object","properties":{"id":{"description":"Inventory item ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalId":{"description":"Deprecated: use productId.","readOnly":true,"title":"externalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"productId":{"description":"Product ID.","readOnly":true,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackQuantity":{"description":"Whether quantity is being tracked.","title":"trackQuantity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variants":{"description":"Variants associated with this inventory item.","title":"variants","type":"array","items":{"$ref":"#/components/schemas/wix.inventory.api.v1.InventoryVariantV2"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastUpdated":{"description":"Last updated timestamp.","readOnly":true,"title":"lastUpdated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numericId":{"description":"Inventory’s unique numeric ID (assigned in ascending order).\nPrimarily for sorting and filtering when crawling all inventories.","readOnly":true,"title":"numericId","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"preorderInfo":{"description":"Preorder information.","$ref":"#/components/schemas/wix.inventory.api.v1.PreorderInfo","summary":"preorderInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InventoryItemV2","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.inventory.api.v1.InventoryVariantV2":{"type":"object","properties":{"variantId":{"description":"Variant ID.","title":"variantId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inStock":{"description":"Whether the product is listed as in stock.","title":"inStock","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Quantity currently left in inventory.","minimum":0,"title":"quantity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"availableForPreorder":{"description":"Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level.","readOnly":true,"title":"availableForPreorder","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InventoryVariantV2","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.inventory.api.v1.PreorderInfo":{"type":"object","properties":{"enabled":{"description":"Whether the item is available for preorder.","title":"enabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"A message the buyer will see when the item is out of stock and preorder is enabled.","minLength":1,"maxLength":250,"title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"Number of products that can be preordered after stock reaches zero.","minimum":0,"maximum":100000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PreorderInfo","description":""},"com.wix.ecommerce.inventory.api.v1.InventoryItemChanged":{"type":"object","properties":{"inventoryItemId":{"description":"Inventory item ID.","title":"inventoryItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalId":{"description":"Deprecated: use productId.","title":"externalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"productId":{"description":"Product ID.","title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackInventory":{"description":"Whether inventory is being tracked.","title":"trackInventory","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"preorderInfo":{"description":"Preorder information.","$ref":"#/components/schemas/wix.inventory.api.v1.PreorderInfo","summary":"preorderInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the inventory item was last updated.","title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InventoryItemChanged","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"com.wix.ecommerce.inventory.api.v1.InventoryVariantsChanged":{"type":"object","properties":{"inventoryItemId":{"description":"Inventory item ID.","title":"inventoryItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalId":{"description":"Deprecated: use productId.","title":"externalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"productId":{"description":"Product ID.","title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variants":{"description":"Information about changed variants.","title":"variants","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecommerce.inventory.api.v1.ChangedInventoryVariant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the inventory variant item was last updated.","title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InventoryVariantsChanged","description":""},"com.wix.ecommerce.inventory.api.v1.ChangedInventoryVariant":{"type":"object","properties":{"id":{"description":"Variant ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldValue":{"description":"Previous inventory variant data.","$ref":"#/components/schemas/com.wix.ecommerce.inventory.api.v1.ChangedInventoryVariantData","summary":"oldValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newValue":{"description":"Current inventory variant data.","$ref":"#/components/schemas/com.wix.ecommerce.inventory.api.v1.ChangedInventoryVariantData","summary":"newValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ChangedInventoryVariant","description":""},"com.wix.ecommerce.inventory.api.v1.ChangedInventoryVariantData":{"type":"object","properties":{"quantity":{"description":"Inventory variant quantity.","title":"quantity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inStock":{"description":"Whether the product variant is in stock.","title":"inStock","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"availableForPreorder":{"description":"Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level.","title":"availableForPreorder","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ChangedInventoryVariantData","description":""},"wix.inventory.api.v1.ReasonTypeWrapper.ReasonType":{"type":"string","description":"","title":"ReasonType","enum":["UNKNOWN","ORDER","MANUAL","REVERT_INVENTORY_CHANGE"]},"wix.inventory.api.v1.GetInventoryVariantsRequest":{"type":"object","properties":{"variantIds":{"description":"Variant IDs to query for this inventory item (optional).","title":"variantIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetInventoryVariantsRequest","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/wix.inventory.api.v1.GetInventoryVariantsRequest.id"}]},"wix.inventory.api.v1.GetInventoryVariantsRequest.id":{"type":"object","title":"id","properties":{"inventoryId":{"description":"Inventory item ID.","title":"inventoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalId":{"description":"Deprecated (use productID instead).","title":"externalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"productId":{"description":"Product ID.","title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.inventory.api.v1.GetInventoryVariantsResponse":{"type":"object","properties":{"inventoryItem":{"description":"Inventory item.","$ref":"#/components/schemas/wix.inventory.api.v1.InventoryItemV2","summary":"inventoryItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetInventoryVariantsResponse","description":""},"wix.inventory.api.v1.GetInventoryItemsRequest":{"type":"object","properties":{"productIds":{"description":"Product IDs","title":"productIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetInventoryItemsRequest","description":""},"wix.inventory.api.v1.GetInventoryItemsResponse":{"type":"object","properties":{"inventoryItems":{"description":"Inventory items.","title":"inventoryItems","type":"array","items":{"$ref":"#/components/schemas/wix.inventory.api.v1.InventoryItemV2"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetInventoryItemsResponse","description":""},"wix.inventory.api.v1.QueryInventoryRequest":{"type":"object","properties":{"query":{"description":"","$ref":"#/components/schemas/wix.inventory.api.v1.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryInventoryRequest","description":""},"wix.inventory.api.v1.Query":{"type":"object","properties":{"paging":{"description":"","$ref":"#/components/schemas/wix.inventory.api.v1.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter string","title":"filter","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort string","title":"sort","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Query","description":""},"wix.inventory.api.v1.Paging":{"type":"object","properties":{"limit":{"description":"Amount of items to load per page","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the display (relevant for all pages after the first)","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"wix.inventory.api.v1.QueryInventoryResponse":{"type":"object","properties":{"inventoryItems":{"description":"Inventory items.","title":"inventoryItems","type":"array","items":{"$ref":"#/components/schemas/wix.inventory.api.v1.InventoryItemV2"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Display metadata.","$ref":"#/components/schemas/wix.inventory.api.v1.PagingMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalResults":{"description":"Number of total results.","title":"totalResults","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryInventoryResponse","description":""},"wix.inventory.api.v1.PagingMetadata":{"type":"object","properties":{"items":{"description":"Amount of items to load per page","title":"items","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the display (relevant for all pages after the first)","title":"offset","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadata","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]},"wix.inventory.api.v1.UpdateInventoryVariantsRequest":{"type":"object","properties":{"inventoryItem":{"description":"Inventory item.","$ref":"#/components/schemas/wix.inventory.api.v1.InventoryItemV2","summary":"inventoryItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateInventoryVariantsRequest","description":""},"wix.inventory.api.v1.UpdateInventoryVariantsResponse":{"type":"object","properties":{},"title":"UpdateInventoryVariantsResponse","description":""},"wix.inventory.api.v1.BulkUpdateInventoryVariantsRequest":{"type":"object","properties":{"filter":{"description":"Variants filter. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateInventoryVariantsRequest","description":"","oneOf":[{"description":"","summary":"action","$ref":"#/components/schemas/wix.inventory.api.v1.BulkUpdateInventoryVariantsRequest.action"}]},"wix.inventory.api.v1.BulkUpdateInventoryVariantsRequest.action":{"type":"object","title":"action","properties":{"setInStock":{"description":"Change availability.","title":"setInStock","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"setQuantity":{"description":"Set new quantity.","title":"setQuantity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"incrementBy":{"description":"Number to increment inventory by.","minimum":1,"title":"incrementBy","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"decrementBy":{"description":"Number to decrement inventory by.","minimum":1,"title":"decrementBy","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.inventory.api.v1.BulkUpdateInventoryVariantsResponse":{"type":"object","properties":{},"title":"BulkUpdateInventoryVariantsResponse","description":""},"wix.inventory.api.v1.BulkUpdateInventoryItemsRequest":{"type":"object","properties":{"variantsFilter":{"description":"Variants filter","title":"variantsFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackInventory":{"description":"Whether inventory is being tracked.","title":"trackInventory","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateInventoryItemsRequest","description":""},"wix.inventory.api.v1.BulkUpdateInventoryItemsResponse":{"type":"object","properties":{},"title":"BulkUpdateInventoryItemsResponse","description":""},"wix.inventory.api.v1.DecrementInventoryRequest":{"type":"object","properties":{"decrementData":{"description":"","minItems":1,"maxItems":300,"title":"decrementData","type":"array","items":{"$ref":"#/components/schemas/wix.inventory.api.v1.DecrementData"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DecrementInventoryRequest","description":""},"wix.inventory.api.v1.DecrementData":{"type":"object","properties":{"variantId":{"description":"Variant ID.","format":"GUID","title":"variantId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"decrementBy":{"description":"Number to decrement inventory by.","minimum":1,"title":"decrementBy","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"preorderRequest":{"description":"Whether the request to decrement the item's inventory was made as part of a purchase that includes preorder items.\nIf true and the item is available for preorder, we allow negative inventory.\nIf false and the item is not available for preorder, we allow regular buy flow (no negative inventory).","title":"preorderRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DecrementData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/wix.inventory.api.v1.DecrementData.id"}]},"wix.inventory.api.v1.DecrementData.id":{"type":"object","title":"id","properties":{"inventoryId":{"description":"Inventory item ID.","maxLength":36,"title":"inventoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalId":{"description":"Deprecated: use productId.","maxLength":36,"title":"externalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"productId":{"description":"Product ID.","maxLength":36,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.inventory.api.v1.DecrementInventoryResponse":{"type":"object","properties":{},"title":"DecrementInventoryResponse","description":""},"wix.inventory.api.v1.IncrementInventoryRequest":{"type":"object","properties":{"incrementData":{"description":"","minItems":1,"maxItems":300,"title":"incrementData","type":"array","items":{"$ref":"#/components/schemas/wix.inventory.api.v1.IncrementData"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncrementInventoryRequest","description":""},"wix.inventory.api.v1.IncrementData":{"type":"object","properties":{"variantId":{"description":"Variant ID.","format":"GUID","title":"variantId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"incrementBy":{"description":"Number to increment inventory by.","minimum":1,"title":"incrementBy","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncrementData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/wix.inventory.api.v1.IncrementData.id"}]},"wix.inventory.api.v1.IncrementData.id":{"type":"object","title":"id","properties":{"inventoryId":{"description":"Inventory item ID.","maxLength":36,"title":"inventoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productId":{"description":"Product ID.","maxLength":36,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.inventory.api.v1.IncrementInventoryResponse":{"type":"object","properties":{},"title":"IncrementInventoryResponse","description":""}}},"title":"Inventory","description":"","fqdn":"wix.stores.v2.inventory"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Inventory API\n\nThis service allows you to query and modify the inventory for your store's products.\n\n(In the future, this service might be used to manage inventory for other things.)\n\n## Terminology\n- **Item** Represents a product from the catalog.\n- **Variant** A product variant. The inventory is managed per variant.\n"},{"displayName":"Using the Inventory API","slugifyName":"using-the-inventory-api","content":"# Using the Inventory API\n\n## Step 1 - Query product variants ([Get Inventory Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::449d21d9-7cf3-439f-a403-6d13a51f78cbslug::get-inventory-variants*fallback::https://dev.wix.com/api/rest/wix-stores/inventory/get-inventory-variants) endpoint)\n\n```\ncurl 'https://www.wixapis.com/stores/v2/inventoryItems/product/{productId}/getVariants' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```\n\nFrom the result, you can see whether inventory is being tracked for this product:\n```json\n{\n \"inventoryItem\": {\n \"id\": \"f8753103-0b3a-b24a-4931-50de280ac31a\",\n \"externalId\": \"078acefc-f4c5-4db5-b6ce-af21d7f53ce5\",\n \"productId\": \"078acefc-f4c5-4db5-b6ce-af21d7f53ce5\",\n \"trackQuantity\": true,\n \"variants\": [\n {\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"inStock\": true,\n \"quantity\": 4\n }\n ],\n \"lastUpdated\": \"2020-08-31T20:05:40.348Z\",\n \"numericId\": \"1598904314932014\"\n }\n}\n```\n\n## Step 2 - Update a specific variant of a product ([Update Inventory Status](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::449d21d9-7cf3-439f-a403-6d13a51f78cbslug::update-inventory-variants*fallback::https://dev.wix.com/api/rest/wix-stores/inventory/update-inventory-variants) endpoint)\n\nUpdate whether the product inventory is tracked:\n```\ncurl 'https://www.wixapis.com/stores/v2/inventoryItems/product/{productId}' -X PATCH --data-binary '{\"inventoryItem\": {\"trackQuantity\": false}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```\n\nFor a non-tracked product, you should update inStock:\n```\ncurl 'https://www.wixapis.com/stores/v2/inventoryItems/product/{productId}' -X PATCH --data-binary '{\"inventoryItem\": {\"trackQuantity\": false,\"variants\": [{\"variantId\": \"00000000-0000-0000-0000-000000000000\",\"inStock\": false}]}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```\n\nFor tracked products, you should update quantity:\n```\ncurl 'https://www.wixapis.com/stores/v2/inventoryItems/product/{productId}' -X PATCH --data-binary '{\"inventoryItem\": {\"trackQuantity\": true,\"variants\": [{\"variantId\": \"00000000-0000-0000-0000-000000000000\",\"quantity\": 4}]}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Get Inventory Variants

Permission Scopes