Shopify Admin API
  1. Product Variant
Shopify Admin API
  • Customers
    • Customer Address
      • Retrieves a list of addresses for a customer
      • Creates a new address for a customer
      • Retrieves details for a single customer address
      • Updates an existing customer address
      • Removes an address from a customer’s address list
      • Performs bulk operations for multiple customer addresses
      • Sets the default address for a customer
    • CustomerSavedSearch
      • Retrieves a list of customer saved searches
      • Creates a customer saved search
      • Retrieves a count of all customer saved searches
      • Retrieves a single customer saved search
      • Updates a customer saved search
      • Deletes a customer saved search
      • Retrieves all customers returned by a customer saved search
    • Customer
      • Retrieves a list of customers
      • Creates a customer
      • Searches for customers that match a supplied query
      • Retrieves a single customer
      • Updates a customer
      • Deletes a customer
      • Creates an account activation URL for a customer
      • Sends an account invite to a customer
      • Retrieves a count of customers
      • Retrieves all orders that belong to a customer
  • Sales channels
    • Checkout
      • Creates a checkout
      • Completes a checkout
      • Retrieves a checkout
      • Modifies an existing checkout
      • Retrieves a list of shipping rates
    • CollectionListing
      • Retrieve collection listings that are published to your app
      • Retrieve product_ids that are published to a collection_id
      • Retrieve a specific collection listing that is published to your app
      • Create a collection listing to publish a collection to your app
      • Delete a collection listing to unpublish a collection from your app
    • Product ResourceFeedback
      • Create a new Product ResourceFeedback
      • Receive a list of all Product ResourceFeedbacks
    • MobilePlatformApplication
      • List all of the mobile platform applications associated with the app
      • Create a mobile platform application
      • Get a mobile platform application
      • Update a mobile platform application
      • Delete a mobile platform application
    • ProductListing
      • Retrieve product listings that are published to your app
      • Retrieve product_ids that are published to your app
      • Retrieve a count of products that are published to your app
      • Retrieve a specific product listing that is published to your app
      • Create a product listing to publish a product to your app
      • Delete a product listing to unpublish a product from your app
    • ResourceFeedback
      • Create a new ResourceFeedback
      • Receive a list of all ResourceFeedbacks
    • Payment
      • Creates a new payment
      • Retrieves a list of payments on a particular checkout
      • Retrieves a single payment
      • Counts the number of payments attempted on a checkout
  • Products
    • Collect
      • Adds a product to a custom collection
      • Retrieves a list of collects
      • Removes a product from a collection
      • Retrieves a specific collect by its ID
      • Retrieves a count of collects
    • Collection
      • Retrieves a single collection
      • Retrieve a list of products belonging to a collection
    • CustomCollection
      • Retrieves a list of custom collections
      • Creates a custom collection
      • Retrieves a count of custom collections
      • Retrieves a single custom collection
      • Updates an existing custom collection
      • Deletes a custom collection
    • Product
      • Retrieve a list of products
      • Create a new product
      • Retrieve a count of products
      • Retrieve a single product
      • Updates a product
      • Delete a product
    • Product Image
      • Receive a list of all Product Images
      • Create a new Product Image
      • Receive a count of all Product Images
      • Receive a single Product Image
      • Modify an existing Product Image
      • Remove an existing Product Image
    • Product Variant
      • Retrieves a list of product variants
        GET
      • Create a new Product Variant
        POST
      • Receive a count of all Product Variants
        GET
      • Receive a single Product Variant
        GET
      • Modify an existing Product Variant
        PUT
      • Remove an existing Product Variant
        DELETE
    • SmartCollection
      • Retrieves a list of smart collections
      • Creates a smart collection
      • Retrieves a count of smart collections
      • Retrieves a single smart collection
      • Updates an existing smart collection
      • Removes a smart collection
      • Updates the ordering type of products in a smart collection
  • Orders
    • Abandoned checkouts
      • Retrieves a list of abandoned checkouts
    • DraftOrder
      • Create a new DraftOrder
      • Retrieves a list of draft orders
      • Modify an existing DraftOrder
      • Receive a single DraftOrder
      • Remove an existing DraftOrder
      • Receive a count of all DraftOrders
      • Send an invoice
      • Complete a draft order
    • Order Risk
      • Creates an order risk for an order
      • Retrieves a list of all order risks for an order
      • Retrieves a single order risk by its ID
      • Updates an order risk
      • Deletes an order risk for an order
    • Transaction
      • Retrieves a list of transactions
      • Creates a transaction for an order
      • Retrieves a count of an order's transactions
      • Retrieves a specific transaction
    • Order
      • Retrieve a list of orders
      • Create an order
      • Retrieve a specific order
      • Update an order
      • Delete an order
      • Retrieve an order count
      • Close an order
      • Re-open a closed order
      • Cancel an order
    • Refund
      • Retrieves a list of refunds for an order
      • Creates a refund
      • Retrieves a specific refund
      • Calculates a refund
  • Access
    • AccessScope
      • Get a list of access scopes
    • StorefrontAccessToken
      • Creates a new StorefrontAccessToken
      • Retrieves a list of storefront access tokens that have been issued
      • Deletes an existing storefront access token
  • Billing
    • ApplicationCredit
      • Creates an application credit
      • Retrieves all application credits
      • Retrieves a single application credit
    • ApplicationCharge
      • Creates an application charge
      • Retrieves a list of application charges
      • Retrieves an application charge
    • UsageCharge
      • Creates a usage charge
      • Retrieves a list of usage charges
      • Retrieves a single charge
    • RecurringApplicationCharge
      • Creates a recurring application charge
      • Retrieves a list of recurring application charges
      • Retrieves a single charge
      • Cancels a recurring application charge
      • Updates the capped amount of a recurring application charge
  • Online store
    • Asset
      • Retrieves a single asset for a theme
      • Creates or updates an asset for a theme
      • Deletes an asset from a theme
    • Blog
      • Retrieve a list of all blogs
      • Create a new Blog
      • Receive a count of all Blogs
      • Receive a single Blog
      • Modify an existing Blog
      • Remove an existing Blog
    • Article
      • Retrieves a list of all articles from a blog
      • Creates an article for a blog
      • Retrieves a count of all articles from a blog
      • Receive a single Article
      • Updates an article
      • Deletes an article
      • Retrieves a list of all article authors
      • Retrieves a list of all article tags
      • Retrieves a list of all article tags from a specific blog
    • Redirect
      • Retrieves a list of URL redirects
      • Creates a redirect
      • Retrieves a count of URL redirects
      • Retrieves a single redirect
      • Updates an existing redirect
      • Deletes a redirect
    • Comment
      • Retrieves a list of comments
      • Creates a comment for an article
      • Retrieves a count of comments
      • Retrieves a single comment by its ID
      • Updates a comment of an article
      • Marks a comment as spam
      • Marks a comment as not spam
      • Approves a comment
      • Removes a comment
      • Restores a previously removed comment
    • ScriptTag
      • Retrieves a list of all script tags
      • Creates a new script tag
      • Retrieves a count of all script tags
      • Retrieves a single script tag
      • Updates a script tag
      • Deletes a script tag
    • Page
      • Retrieves a list of pages
      • Creates a page
      • Retrieves a page count
      • Retrieves a single page by its ID
      • Updates a page
      • Deletes a page
    • Theme
      • Retrieves a list of themes
      • Creates a theme
      • Retrieves a single theme by its ID
      • Modify an existing Theme
      • Remove an existing Theme
  • Shipping and fulfillment
    • CancellationRequest
      • Sends a cancellation request
      • Accepts a cancellation request
      • Rejects a cancellation request
    • CarrierService
      • Create a new CarrierService
      • Receive a list of all CarrierServices
      • Modify an existing CarrierService
      • Receive a single CarrierService
      • Remove an existing CarrierService
    • AssignedFulfillmentOrder
      • Retrieves a list of fulfillment orders on a shop for a specific app
    • FulfillmentEvent
      • Retrieves a list of fulfillment events for a specific fulfillment
      • Creates a fulfillment event
      • Retrieves a specific fulfillment event
      • Deletes a fulfillment event
    • Fulfillment
      • Retrieves fulfillments associated with an order
      • Retrieves fulfillments associated with a fulfillment order
      • Retrieves a count of fulfillments associated with a specific order
      • Receive a single Fulfillment
      • Creates a fulfillment for one or many fulfillment orders
      • Updates the tracking information for a fulfillment
      • Cancels a fulfillment
    • FulfillmentOrder
      • Retrieves a list of fulfillment orders for a specific order
      • Retrieves a specific fulfillment order
      • Cancel a fulfillment order
      • Marks a fulfillment order as incomplete
      • Moves a fulfillment order to a new location
      • Marks the fulfillment order as open
      • Reschedules the fulfill_at time of a scheduled fulfillment order
      • Applies a fulfillment hold on an open fulfillment order
      • Sets deadline for fulfillment orders
      • Releases the fulfillment hold on a fulfillment order
    • LocationsForMove
      • Retrieves a list of locations that a fulfillment order can potentially move to.
    • FulfillmentRequest
      • Sends a fulfillment request
      • Accepts a fulfillment request
      • Rejects a fulfillment request
    • FulfillmentService
      • Receive a list of all FulfillmentServices
      • Create a new FulfillmentService
      • Receive a single FulfillmentService
      • Modify an existing FulfillmentService
      • Remove an existing FulfillmentService
  • Shopify Payments
    • Balance
      • Return the current balance
    • Dispute
      • Return a list of all disputes
      • Return a single dispute
    • Payouts
      • Return a list of all payouts
      • Return a single payout
    • Transactions
      • Return a list of all balance transactions
  • Analytics
    • Report
      • Retrieves a list of reports
      • Creates a new report
      • Retrieves a single report
      • Updates a report
      • Deletes a report
  • Deprecated API calls
    • Deprecated API calls
      • Retrieves a list of deprecated API calls
  • Discounts
    • DiscountCode
      • Creates a discount code
      • Retrieves a list of discount codes
      • Updates an existing discount code
      • Retrieves a single discount code
      • Deletes a discount code
      • Retrieves the location of a discount code
      • Retrieves a count of discount codes for a shop
      • Creates a discount code creation job
      • Retrieves a discount code creation job
      • Retrieves a list of discount codes for a discount code creation job
    • PriceRule
      • Creates a price rule
      • Retrieves a list of price rules
      • Updates an existing a price rule
      • Retrieves a single price rule
      • Remove an existing PriceRule
      • Retrieves a count of all price rules
  • Inventory
    • InventoryItem
      • Retrieves a detailed list for inventory items by IDs
      • Retrieves a single inventory item by ID
      • Updates an existing inventory item
    • Location
      • Retrieve a list of locations
      • Retrieve a single location by its ID
      • Retrieve a count of locations
      • Retrieve a list of inventory levels for a location
    • InventoryLevel
      • Retrieves a list of inventory levels
      • Deletes an inventory level from a location
      • Adjusts the inventory level of an inventory item at a location
      • Connects an inventory item to a location
      • Sets the inventory level for an inventory item at a location
  • Events
    • Event
      • Retrieves a list of events
      • Retrieves a single event
      • Retrieves a count of events
    • Webhook
      • Retrieves a list of webhooks
      • Create a new Webhook
      • Receive a count of all Webhooks
      • Receive a single Webhook
      • Modify an existing Webhook
      • Remove an existing Webhook
  • MarketingEvent
    • MarketingEvent
      • Retrieves a list of all marketing events
      • Creates a marketing event
      • Retrieves a count of all marketing events
      • Retrieves a single marketing event
      • Updates a marketing event
      • Deletes a marketing event
      • Creates marketing engagements on a marketing event
  • Metafield
    • Metafield
      • Retrieve a list of metafields from the resource's endpoint
      • Create a metafield
      • Retrieve a list of metafields by using query parameters
      • Retrieve a count of a resource's metafields.
      • Retrieve a specific metafield
      • Updates a metafield
      • Deletes a metafield by its ID
  • Plus
    • Gift Card
      • Retrieves a list of gift cards
      • Creates a gift card
      • Retrieves a single gift card
      • Updates an existing gift card
      • Retrieves a count of gift cards
      • Disables a gift card
      • Searches for gift cards
    • User
      • Retrieves a list of all users
      • Retrieves a single user
      • Retrieves the currently logged-in user
  • Store properties
    • Country
      • Receive a list of all Countries
      • Creates a country
      • Retrieves a count of countries
      • Retrieves a specific county
      • Updates an existing country
      • Remove an existing Country
    • Currency
      • Retrieves a list of currencies enabled on a shop
    • Policy
      • Retrieves a list of the shop's policies
    • ShippingZone
      • Receive a list of all ShippingZones
    • Province
      • Retrieves a list of provinces for a country
      • Retrieves a count of provinces for a country
      • Retrieves a single province for a country
      • Updates an existing province for a country
    • Shop
      • Retrieves the shop's configuration
  • TenderTransaction
    • TenderTransaction
      • Retrieves a list of tender transactions
  1. Product Variant

Receive a single Product Variant

GET
/admin/api/{api_version}/variants/{variant_id}.json
Retrieves a single product variant by ID

请求参数

Path 参数
api_version
string 
必需
variant_id
string 
必需
Query 参数
fields
string 
可选
A comma-separated list of fields to include in the response

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.myshopify.com//admin/api//variants/.json'

返回响应

🟢200Receive a single Product Variant
application/json
Body
variant
object (Product Variant) 
可选
barcode
string 
可选
The barcode, UPC, or ISBN number for the product.
compare_at_price
string 
可选
The original price of the item before an adjustment or a sale.
created_at
string 
可选
The date and time (ISO 8601 format) when the product variant was created.
fulfillment_service
string 
可选
The fulfillment service associated with the product variant. Valid values: manual or the handle of a
fulfillment service.
Multi-managed inventory introduced a breaking change to this field.
Fulfillment services will all be opted into SKU sharing in 2023-04.
This field is due to be deprecated and will no longer be supported.
Please refer to InventoryLevel to see how variants are associated to multiple fulfillment services.
grams
string 
可选
The weight of the product variant in grams.
id
string 
可选
The unique numeric identifier for the product variant.
image_id
string 
可选
The unique numeric identifier for a product's image.
The image must be associated to the same product as the variant.
inventory_item_id
string 
可选
The unique identifier for the inventory item, which is used in the Inventory API to query for inventory information.
inventory_management
string 
可选
The fulfillment service that tracks the number of items in stock for the product variant.
Valid values:
  • shopify: You are tracking inventory yourself using the admin.
  • null: You aren't tracking inventory on the variant.
  • the handle of a fulfillment service that has inventory management enabled: This must be the same fulfillment service referenced by the fulfillment_service property.
inventory_policy
string 
可选

Whether customers are allowed to place an order for the product variant when it's out of stock. Valid values:

  • deny: Customers are not allowed to place orders for the product variant if it's out of stock.
  • continue: Customers are allowed to place orders for the product variant if it's out of stock.
Default value: deny.
inventory_quantity
string 
只读可选
An aggregate of inventory across all locations. To adjust inventory at a specific location, use the
InventoryLevel resource.
old_inventory_quantity
string 
已废弃
This property is deprecated. Use the
InventoryLevel resource instead.
inventory_quantity_adjustment
string 
已废弃
This property is deprecated. Use the
InventoryLevel resource instead.
option
string 
可选
The custom properties that a shop owner uses to define product variants.
You can define three options for a product variant: option1, option2, option3.
Default value: Default Title.
The title field is a concatenation of the option1, option2, and
option3 fields. Updating the option fields updates the title field.
presentment_prices
string 
只读可选
A list of the variant's presentment prices and compare-at prices in each of the shop's enabled presentment currencies. Each price object has the following properties:
  • currency_code: The three-letter code (ISO 4217 format) for one of the shop's enabled presentment currencies.
  • amount: The variant's price or compare-at price in the presentment currency.
Requires the header 'X-Shopify-Api-Features': 'include-presentment-prices'.
position
string 
只读可选
The order of the product variant in the list of product variants.
The first position in the list is 1.
The position of variants is indicated by the order in which they are listed.
price
string 
可选
The price of the product variant.
product_id
string 
可选
The unique numeric identifier for the product.
requires_shipping
string 
已废弃
This property is deprecated. Use the requires_shipping property on the InventoryItem resource instead.
sku
string 
可选
A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService.
taxable
string 
可选
Whether a tax is charged when the product variant is sold.
tax_code
string 
可选
This parameter applies only to the stores that have the Avalara AvaTax app installed. Specifies the Avalara tax code for the product variant.
title
string 
只读可选
The title of the product variant. The title field is a concatenation of the option1, option2, and option3 fields. You can only update title indirectly using the option fields.
updated_at
string 
可选
The date and time when the product variant was last modified.
Gets returned in ISO 8601 format.
weight
string 
可选
The weight of the product variant in the unit system specified with weight_unit.
weight_unit
string 
可选
The unit of measurement that applies to the product variant's weight.
If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied.
Valid values: g, kg, oz, and lb.
示例
{
    "variant": {
        "id": 808950810,
        "product_id": 632910392,
        "title": "Pink",
        "price": "199.00",
        "sku": "IPOD2008PINK",
        "position": 1,
        "inventory_policy": "continue",
        "compare_at_price": null,
        "fulfillment_service": "manual",
        "inventory_management": "shopify",
        "option1": "Pink",
        "option2": null,
        "option3": null,
        "created_at": "2023-01-03T12:21:36-05:00",
        "updated_at": "2023-01-03T12:21:36-05:00",
        "taxable": true,
        "barcode": "1234_pink",
        "grams": 567,
        "image_id": 562641783,
        "weight": 1.25,
        "weight_unit": "lb",
        "inventory_item_id": 808950810,
        "inventory_quantity": 10,
        "old_inventory_quantity": 10,
        "presentment_prices": [
            {
                "price": {
                    "amount": "199.00",
                    "currency_code": "USD"
                },
                "compare_at_price": null
            }
        ],
        "tax_code": "DA040000",
        "requires_shipping": true,
        "admin_graphql_api_id": "gid://shopify/ProductVariant/808950810"
    }
}
修改于 2023-01-29 12:00:34
上一页
Receive a count of all Product Variants
下一页
Modify an existing Product Variant
Built with