The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
products
access scope.
Important
Listing, creating, updating, and deleting product variants is deprecated as of REST API 2024-04. For more information, refer to the guide to the new product model.
Important
Apps can no longer set inventory using inventory_quantity
. For more information, refer to the Inventory Level
resource.
This is the handle of a third-party fulfillment service if the following conditions are met:
- The product variant is stocked by a single fulfillment service.
- The FulfillmentService is a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value
manual
. - The fulfillment service hasn't opted into SKU sharing.
manual
.
The relationship between a product variant and a fulfillment service was changed in the 2022-07
API version. A ProductVariant can be stocked by multiple fulfillment services. As a result, we recommend that you use the InventoryLevel resource if you need to determine where a product variant is stocked.
If you previously set this field, then we recommend that you instead connect an inventory item to a location. Each Location is associated with a single FulfillmentService. The value of this field after setting it will be as described above.
If you need to determine whether a product is a gift card, then you should continue to use this field until an alternative is available.
Learn more about managing inventory quantities and states.