REST Admin API for managing products, orders, customers, and more.
https://shopify.com1473 endpoints available
/fetch_stockGet inventory levels
/fetch_tracking_numbersGet tracking numbers for orders
/admin/api/2020-01/shop.jsonRetrieves the shop's configuration
/admin/api/2020-04/shop.jsonRetrieves the shop's configuration
/admin/api/2020-07/shop.jsonRetrieves the shop's configuration
/admin/api/2020-10/shop.jsonRetrieves the shop's configuration
/admin/api/2021-01/shop.jsonRetrieves the shop's configuration
/admin/api/2020-01/blogs.jsonRetrieve a list of all blogs. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/blogs.jsonCreate a new blog
/admin/api/2020-01/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/shop.jsonRetrieves the shop's configuration
/admin/api/2020-01/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders.jsonRetrieves a list of orders. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders.jsonCreates an order. By default, product inventory is not claimed. When you create an order, you can include the following option parameters in the body of the request: inventory_behaviour: The behaviour to use when updating inventory. (default: bypass) bypass: Do not claim inventory. decrement_ignoring_policy: Ignore the product's inventory policy and claim inventory. decrement_obeying_policy: Follow the product's inventory policy and claim inventory, if possible. send_receipt: Whether to send an order confirmation to the customer. Note If you're working on a private app and order confirmations are still being sent to the customer when send_receipt is set to false, then you need to disable the Storefront API from the private app's page in the Shopify admin. send_fulfillment_receipt: Whether to send a shipping confirmation to the customer. Note If you are including shipping_address or billing_address, make sure to pass both first_name and last_name. Otherwise both these addresses will be ignored. If you're using this endpoint with a trial or Partner development store, then you can create no more than 5 new orders per minute.
/admin/api/2020-01/themes.jsonRetrieves a list of themes.
/admin/api/2020-01/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/api/2020-04/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders.jsonRetrieves a list of orders. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders.jsonCreates an order. By default, product inventory is not claimed. When you create an order, you can include the following option parameters in the body of the request: inventory_behaviour: The behaviour to use when updating inventory. (default: bypass) bypass: Do not claim inventory. decrement_ignoring_policy: Ignore the product's inventory policy and claim inventory. decrement_obeying_policy: Follow the product's inventory policy and claim inventory, if possible. send_receipt: Whether to send an order confirmation to the customer. Note If you're working on a private app and order confirmations are still being sent to the customer when send_receipt is set to false, then you need to disable the Storefront API from the private app's page in the Shopify admin. send_fulfillment_receipt: Whether to send a shipping confirmation to the customer. Note If you are including shipping_address or billing_address, make sure to pass both first_name and last_name. Otherwise both these addresses will be ignored. If you're using this endpoint with a trial or Partner development store, then you can create no more than 5 new orders per minute.
/admin/api/2020-04/themes.jsonRetrieves a list of themes.
/admin/api/2020-04/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/api/2020-07/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/orders.jsonRetrieves a list of orders. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/themes.jsonRetrieves a list of themes.
/admin/api/2020-07/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/api/2020-10/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/themes.jsonRetrieves a list of themes.
/admin/api/2020-10/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/api/2021-01/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/themes.jsonRetrieves a list of themes.
/admin/api/2021-01/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/api/unstable/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/reports.jsonCreates a new report
/admin/api/2020-04/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/reports.jsonCreates a new report
/admin/api/2020-07/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/reports.jsonCreates a new report
/admin/api/2020-10/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/reports.jsonCreates a new report
/admin/api/2021-01/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/reports.jsonCreates a new report
/admin/api/unstable/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/themes.jsonRetrieves a list of themes.
/admin/api/unstable/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/oauth/access_scopes.jsonRetrieves a list of access scopes associated to the access token.
/admin/api/2020-01/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/collects.jsonAdds a product to a custom collection.
/admin/api/2020-01/comments.jsonRetrieves a list of comments. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/comments.jsonCreates a comment for an article
/admin/api/2020-01/policies.jsonRetrieves a list of the shop's policies
/admin/api/2020-01/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-01/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/2020-04/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/collects.jsonAdds a product to a custom collection.
/admin/api/2020-04/policies.jsonRetrieves a list of the shop's policies
/admin/api/2020-04/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-04/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/2020-07/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/collects.jsonAdds a product to a custom collection.
/admin/api/2020-07/policies.jsonRetrieves a list of the shop's policies
/admin/api/2020-07/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-07/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/2020-10/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/collects.jsonAdds a product to a custom collection.
/admin/api/2020-10/policies.jsonRetrieves a list of the shop's policies
/admin/api/2020-10/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-10/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/2021-01/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/collects.jsonAdds a product to a custom collection.
/admin/api/2021-01/policies.jsonRetrieves a list of the shop's policies
/admin/api/2021-01/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2021-01/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/unstable/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/reports.jsonCreates a new report
/admin/api/2020-01/checkouts.jsonCreates a checkout
/admin/api/2020-01/countries.jsonRetrieves a list of countries.
/admin/api/2020-01/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/2020-01/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/customers.jsonCreates a customer.
/admin/api/2020-01/locations.jsonRetrieves a list of locations
/admin/api/2020-01/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/2020-04/checkouts.jsonCreates a checkout
/admin/api/2020-04/countries.jsonRetrieves a list of countries.
/admin/api/2020-04/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/2020-04/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/customers.jsonCreates a customer.
/admin/api/2020-04/locations.jsonRetrieves a list of locations
/admin/api/2020-04/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/2020-07/checkouts.jsonCreates a checkout
/admin/api/2020-07/countries.jsonRetrieves a list of countries.
/admin/api/2020-07/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/2020-07/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/customers.jsonCreates a customer.
/admin/api/2020-07/locations.jsonRetrieves a list of locations
/admin/api/2020-07/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/2020-10/checkouts.jsonCreates a checkout
/admin/api/2020-10/countries.jsonRetrieves a list of countries.
/admin/api/2020-10/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/2020-10/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/customers.jsonCreates a customer.
/admin/api/2020-10/locations.jsonRetrieves a list of locations
/admin/api/2020-10/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/2021-01/checkouts.jsonCreates a checkout
/admin/api/2021-01/countries.jsonRetrieves a list of countries.
/admin/api/2021-01/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/2021-01/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/customers.jsonCreates a customer.
/admin/api/2021-01/locations.jsonRetrieves a list of locations
/admin/api/2021-01/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/unstable/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/collects.jsonAdds a product to a custom collection.
/admin/api/unstable/policies.jsonRetrieves a list of the shop's policies
/admin/api/unstable/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/unstable/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/2020-01/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/2020-01/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/gift_cards.jsonCreates a gift card
/admin/api/2020-01/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/2020-01/metafields.jsonCreates a new metafield for a resource.
/admin/api/2020-04/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/2020-04/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/gift_cards.jsonCreates a gift card
/admin/api/2020-04/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/2020-04/metafields.jsonCreates a new metafield for a resource.
/admin/api/2020-07/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/2020-07/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/gift_cards.jsonCreates a gift card
/admin/api/2020-07/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/2020-07/metafields.jsonCreates a new metafield for a resource.
/admin/api/2020-10/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/2020-10/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/gift_cards.jsonCreates a gift card
/admin/api/2020-10/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/2020-10/metafields.jsonCreates a new metafield for a resource.
/admin/api/2021-01/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/2021-01/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/gift_cards.jsonCreates a gift card
/admin/api/2021-01/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/2021-01/metafields.jsonCreates a new metafield for a resource.
/admin/api/unstable/checkouts.jsonCreates a checkout
/admin/api/unstable/countries.jsonRetrieves a list of countries.
/admin/api/unstable/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/unstable/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/customers.jsonCreates a customer.
/admin/api/unstable/locations.jsonRetrieves a list of locations
/admin/api/unstable/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/2020-01/blogs/count.jsonGet a count of all blogs
/admin/api/2020-01/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/script_tags.jsonCreates a new script tag
/admin/api/2020-04/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/script_tags.jsonCreates a new script tag
/admin/api/2020-07/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/script_tags.jsonCreates a new script tag
/admin/api/2020-10/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/script_tags.jsonCreates a new script tag
/admin/api/2021-01/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/script_tags.jsonCreates a new script tag
/admin/api/unstable/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/unstable/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/gift_cards.jsonCreates a gift card
/admin/api/unstable/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/unstable/metafields.jsonCreates a new metafield for a resource.
/admin/api/2020-01/events/count.jsonRetrieves a count of events
/admin/api/2020-01/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/2020-01/orders/count.jsonRetrieves an order count
/admin/api/2020-04/events/count.jsonRetrieves a count of events
/admin/api/2020-04/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/2020-04/orders/count.jsonRetrieves an order count
/admin/api/2020-07/events/count.jsonRetrieves a count of events
/admin/api/2020-07/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/2020-10/events/count.jsonRetrieves a count of events
/admin/api/2020-10/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/2021-01/events/count.jsonRetrieves a count of events
/admin/api/2021-01/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/unstable/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/script_tags.jsonCreates a new script tag
/admin/api/2020-01/articles/tags.jsonRetrieves a list of all the tags
/admin/api/2020-01/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/2020-04/articles/tags.jsonRetrieves a list of all the tags
/admin/api/2020-04/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/2020-07/articles/tags.jsonRetrieves a list of all the tags
/admin/api/2020-07/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/2020-10/articles/tags.jsonRetrieves a list of all the tags
/admin/api/2020-10/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/2021-01/articles/tags.jsonRetrieves a list of all the tags
/admin/api/2021-01/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/unstable/events/count.jsonRetrieves a count of events
/admin/api/unstable/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/2020-01/collects/count.jsonRetrieves a count of collects.
/admin/api/2020-01/comments/count.jsonRetrieves a count of comments
/admin/api/2020-01/products/count.jsonRetrieves a count of products.
/admin/api/2020-01/shipping_zones.jsonGet a list of all shipping zones
/admin/api/2020-01/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/2020-04/collects/count.jsonRetrieves a count of collects.
/admin/api/2020-04/products/count.jsonRetrieves a count of products.
/admin/api/2020-04/shipping_zones.jsonGet a list of all shipping zones
/admin/api/2020-04/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/2020-07/collects/count.jsonRetrieves a count of collects.
/admin/api/2020-07/products/count.jsonRetrieves a count of products.
/admin/api/2020-07/shipping_zones.jsonGet a list of all shipping zones
/admin/api/2020-07/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/2020-10/collects/count.jsonRetrieves a count of collects.
/admin/api/2020-10/products/count.jsonRetrieves a count of products.
/admin/api/2020-10/shipping_zones.jsonGet a list of all shipping zones
/admin/api/2020-10/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/2021-01/collects/count.jsonRetrieves a count of collects.
/admin/api/2021-01/products/count.jsonRetrieves a count of products.
/admin/api/2021-01/shipping_zones.jsonGet a list of all shipping zones
/admin/api/2021-01/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/unstable/articles/tags.jsonRetrieves a list of all the tags
/admin/api/unstable/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/2020-01/blogs/{blog_id}.jsonGet a single blog by its ID
/admin/api/2020-01/blogs/{blog_id}.jsonUpdate a blog
/admin/api/2020-01/blogs/{blog_id}.jsonDelete a blog
/admin/api/2020-01/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/2020-01/countries/count.jsonRetrieves a count of countries.
/admin/api/2020-01/customers/count.jsonRetrieves a count of all customers.
/admin/api/2020-01/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/locations/count.jsonRetrieves a count of locations
/admin/api/2020-01/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/2020-01/users/{user_id}.jsonRetrieves a single user
/admin/api/2020-04/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/2020-04/countries/count.jsonRetrieves a count of countries.
/admin/api/2020-04/customers/count.jsonRetrieves a count of all customers.
/admin/api/2020-04/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/locations/count.jsonRetrieves a count of locations
/admin/api/2020-04/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/2020-04/users/{user_id}.jsonRetrieves a single user
/admin/api/2020-07/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/2020-07/countries/count.jsonRetrieves a count of countries.
/admin/api/2020-07/customers/count.jsonRetrieves a count of all customers.
/admin/api/2020-07/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/locations/count.jsonRetrieves a count of locations
/admin/api/2020-07/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/2020-07/users/{user_id}.jsonRetrieves a single user
/admin/api/2020-10/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/2020-10/countries/count.jsonRetrieves a count of countries.
/admin/api/2020-10/customers/count.jsonRetrieves a count of all customers.
/admin/api/2020-10/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/locations/count.jsonRetrieves a count of locations
/admin/api/2020-10/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/2020-10/users/{user_id}.jsonRetrieves a single user
/admin/api/2021-01/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/2021-01/countries/count.jsonRetrieves a count of countries.
/admin/api/2021-01/customers/count.jsonRetrieves a count of all customers.
/admin/api/2021-01/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/locations/count.jsonRetrieves a count of locations
/admin/api/2021-01/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/2021-01/users/{user_id}.jsonRetrieves a single user
/admin/api/unstable/collects/count.jsonRetrieves a count of collects.
/admin/api/unstable/products/count.jsonRetrieves a count of products.
/admin/api/unstable/shipping_zones.jsonGet a list of all shipping zones
/admin/api/unstable/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/2020-01/articles/authors.jsonRetrieves a list all of article authors
/admin/api/2020-01/carrier_services.jsonRetrieves a list of carrier services
/admin/api/2020-01/carrier_services.jsonCreates a carrier service
/admin/api/2020-01/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/2020-01/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/2020-01/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/2020-01/product_listings.jsonRetrieve product listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/articles/authors.jsonRetrieves a list all of article authors
/admin/api/2020-04/carrier_services.jsonRetrieves a list of carrier services
/admin/api/2020-04/carrier_services.jsonCreates a carrier service
/admin/api/2020-04/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/2020-04/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/2020-04/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/2020-04/product_listings.jsonRetrieve product listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/articles/authors.jsonRetrieves a list all of article authors
/admin/api/2020-07/carrier_services.jsonRetrieves a list of carrier services
/admin/api/2020-07/carrier_services.jsonCreates a carrier service
/admin/api/2020-07/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/2020-07/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/2020-07/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/2020-07/product_listings.jsonRetrieve product listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/articles/authors.jsonRetrieves a list all of article authors
/admin/api/2020-10/carrier_services.jsonRetrieves a list of carrier services
/admin/api/2020-10/carrier_services.jsonCreates a carrier service
/admin/api/2020-10/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/2020-10/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/2020-10/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/2021-01/articles/authors.jsonRetrieves a list all of article authors
/admin/api/2021-01/carrier_services.jsonRetrieves a list of carrier services
/admin/api/2021-01/carrier_services.jsonCreates a carrier service
/admin/api/2021-01/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/2021-01/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/2021-01/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/unstable/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/unstable/countries/count.jsonRetrieves a count of countries.
/admin/api/unstable/customers/count.jsonRetrieves a count of all customers.
/admin/api/unstable/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/locations/count.jsonRetrieves a count of locations
/admin/api/unstable/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/unstable/users/{user_id}.jsonRetrieves a single user
/admin/api/2020-01/checkouts/{token}.jsonRetrieves a checkout
/admin/api/2020-01/checkouts/{token}.jsonModifies an existing checkout
/admin/api/2020-01/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/2020-01/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders/{order_id}.jsonRetrieves a specific order
/admin/api/2020-01/orders/{order_id}.jsonUpdates an order
/admin/api/2020-01/orders/{order_id}.jsonDeletes an order. Orders that interact with an online gateway can't be deleted.
/admin/api/2020-01/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/2020-01/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/2020-01/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/2020-01/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/2020-01/themes/{theme_id}.jsonDeletes a theme.
/admin/api/2020-04/checkouts/{token}.jsonRetrieves a checkout
/admin/api/2020-04/checkouts/{token}.jsonModifies an existing checkout
/admin/api/2020-04/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/2020-04/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders/{order_id}.jsonRetrieves a specific order
/admin/api/2020-04/orders/{order_id}.jsonUpdates an order
/admin/api/2020-04/orders/{order_id}.jsonDeletes an order. Orders that interact with an online gateway can't be deleted.
/admin/api/2020-04/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/2020-04/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/2020-04/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/2020-04/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/2020-04/themes/{theme_id}.jsonDeletes a theme.
/admin/api/2020-07/checkouts/{token}.jsonRetrieves a checkout
/admin/api/2020-07/checkouts/{token}.jsonModifies an existing checkout
/admin/api/2020-07/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/2020-07/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/2020-07/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/2020-07/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/2020-07/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/2020-07/themes/{theme_id}.jsonDeletes a theme.
/admin/api/2020-10/checkouts/{token}.jsonRetrieves a checkout
/admin/api/2020-10/checkouts/{token}.jsonModifies an existing checkout
/admin/api/2020-10/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/2020-10/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/2020-10/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/2020-10/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/2020-10/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/2020-10/themes/{theme_id}.jsonDeletes a theme.
/admin/api/2021-01/checkouts/{token}.jsonRetrieves a checkout
/admin/api/2021-01/checkouts/{token}.jsonModifies an existing checkout
/admin/api/2021-01/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/2021-01/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/2021-01/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/2021-01/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/2021-01/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/2021-01/themes/{theme_id}.jsonDeletes a theme.
/admin/api/unstable/articles/authors.jsonRetrieves a list all of article authors
/admin/api/unstable/carrier_services.jsonRetrieves a list of carrier services
/admin/api/unstable/carrier_services.jsonCreates a carrier service
/admin/api/unstable/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/unstable/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/unstable/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/2020-01/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/custom_collections.jsonCreates a custom collection
/admin/api/2020-04/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/custom_collections.jsonCreates a custom collection
/admin/api/2020-07/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/custom_collections.jsonCreates a custom collection
/admin/api/2020-10/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/custom_collections.jsonCreates a custom collection
/admin/api/2021-01/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/custom_collections.jsonCreates a custom collection
/admin/api/unstable/checkouts/{token}.jsonRetrieves a checkout
/admin/api/unstable/checkouts/{token}.jsonModifies an existing checkout
/admin/api/unstable/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/unstable/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/unstable/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/unstable/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/unstable/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/unstable/themes/{theme_id}.jsonDeletes a theme.
/admin/api/2020-01/application_charges.jsonRetrieves a list of application charges
/admin/api/2020-01/application_charges.jsonCreates an application charge
/admin/api/2020-01/application_credits.jsonRetrieves all application credits
/admin/api/2020-01/application_credits.jsonCreates an application credit
/admin/api/2020-01/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/2020-01/reports/{report_id}.jsonUpdates a report
/admin/api/2020-01/reports/{report_id}.jsonDeletes a report
/admin/api/2020-01/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/application_charges.jsonRetrieves a list of application charges
/admin/api/2020-04/application_charges.jsonCreates an application charge
/admin/api/2020-04/application_credits.jsonRetrieves all application credits
/admin/api/2020-04/application_credits.jsonCreates an application credit
/admin/api/2020-04/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/2020-04/reports/{report_id}.jsonUpdates a report
/admin/api/2020-04/reports/{report_id}.jsonDeletes a report
/admin/api/2020-04/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/application_charges.jsonRetrieves a list of application charges
/admin/api/2020-07/application_charges.jsonCreates an application charge
/admin/api/2020-07/application_credits.jsonRetrieves all application credits
/admin/api/2020-07/application_credits.jsonCreates an application credit
/admin/api/2020-07/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/2020-07/reports/{report_id}.jsonUpdates a report
/admin/api/2020-07/reports/{report_id}.jsonDeletes a report
/admin/api/2020-07/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/application_charges.jsonRetrieves a list of application charges
/admin/api/2020-10/application_charges.jsonCreates an application charge
/admin/api/2020-10/application_credits.jsonRetrieves all application credits
/admin/api/2020-10/application_credits.jsonCreates an application credit
/admin/api/2020-10/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/2020-10/reports/{report_id}.jsonUpdates a report
/admin/api/2020-10/reports/{report_id}.jsonDeletes a report
/admin/api/2020-10/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/application_charges.jsonRetrieves a list of application charges
/admin/api/2021-01/application_charges.jsonCreates an application charge
/admin/api/2021-01/application_credits.jsonRetrieves all application credits
/admin/api/2021-01/application_credits.jsonCreates an application credit
/admin/api/2021-01/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/2021-01/reports/{report_id}.jsonUpdates a report
/admin/api/2021-01/reports/{report_id}.jsonDeletes a report
/admin/api/2021-01/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/custom_collections.jsonCreates a custom collection
/admin/api/2020-01/fulfillment_services.json/admin/api/2020-01/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/2020-01/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-04/fulfillment_services.json/admin/api/2020-04/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/2020-04/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-07/fulfillment_services.json/admin/api/2020-07/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/2020-07/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-10/fulfillment_services.json/admin/api/2020-10/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/2020-10/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2021-01/deprecated_api_calls.jsonRetrieves a list of deprecated API calls made by the authenticated private app in the past 30 days.
/admin/api/2021-01/fulfillment_services.json/admin/api/2021-01/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/2021-01/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/unstable/application_charges.jsonRetrieves a list of application charges
/admin/api/unstable/application_charges.jsonCreates an application charge
/admin/api/unstable/application_credits.jsonRetrieves all application credits
/admin/api/unstable/application_credits.jsonCreates an application credit
/admin/api/unstable/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/unstable/reports/{report_id}.jsonUpdates a report
/admin/api/unstable/reports/{report_id}.jsonDeletes a report
/admin/api/unstable/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/2020-01/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/2020-01/comments/{comment_id}.jsonRetrieves a single comment by its ID
/admin/api/2020-01/comments/{comment_id}.jsonUpdates a comment of an article
/admin/api/2020-01/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/2020-01/products/{product_id}.jsonRetrieves a single product.
/admin/api/2020-01/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-01/products/{product_id}.jsonDeletes a product.
/admin/api/2020-01/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/2020-01/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/2020-01/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/2020-04/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/2020-04/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/2020-04/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/2020-04/products/{product_id}.jsonRetrieves a single product.
/admin/api/2020-04/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-04/products/{product_id}.jsonDeletes a product.
/admin/api/2020-04/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/2020-04/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/2020-04/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/2020-07/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/2020-07/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/2020-07/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/2020-07/products/{product_id}.jsonRetrieves a single product.
/admin/api/2020-07/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-07/products/{product_id}.jsonDeletes a product.
/admin/api/2020-07/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/2020-07/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/2020-07/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/2020-10/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/2020-10/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/2020-10/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/2020-10/products/{product_id}.jsonRetrieves a single product.
/admin/api/2020-10/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-10/products/{product_id}.jsonDeletes a product.
/admin/api/2020-10/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/2020-10/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/2020-10/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/2021-01/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/2021-01/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/2021-01/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/2021-01/products/{product_id}.jsonRetrieves a single product.
/admin/api/2021-01/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2021-01/products/{product_id}.jsonDeletes a product.
/admin/api/2021-01/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/2021-01/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/2021-01/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/unstable/deprecated_api_calls.jsonRetrieves a list of deprecated API calls made by the authenticated private app in the past 30 days.
/admin/api/unstable/fulfillment_services.json/admin/api/unstable/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/unstable/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-01/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/2020-01/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/2020-01/countries/{country_id}.jsonDeletes a country.
/admin/api/2020-01/orders/{order_id}/open.jsonRe-opens a closed order
/admin/api/2020-01/product_listings/count.jsonRetrieve a count of products that are published to your app
/admin/api/2020-04/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/2020-04/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/2020-04/countries/{country_id}.jsonDeletes a country.
/admin/api/2020-04/orders/{order_id}/open.jsonRe-opens a closed order
/admin/api/2020-04/product_listings/count.jsonRetrieve a count of products that are published to your app
/admin/api/2020-07/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/2020-07/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/2020-07/countries/{country_id}.jsonDeletes a country.
/admin/api/2020-07/product_listings/count.jsonRetrieve a count of products that are published to your app
/admin/api/2020-10/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/2020-10/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/2020-10/countries/{country_id}.jsonDeletes a country.
/admin/api/2021-01/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/2021-01/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/2021-01/countries/{country_id}.jsonDeletes a country.
/admin/api/unstable/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/unstable/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/unstable/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/unstable/products/{product_id}.jsonRetrieves a single product.
/admin/api/unstable/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/unstable/products/{product_id}.jsonDeletes a product.
/admin/api/unstable/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/unstable/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/unstable/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/2020-01/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/2020-01/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/2020-01/customers/{customer_id}.jsonUpdates a customer.
/admin/api/2020-01/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/2020-01/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/2020-01/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/2020-01/orders/{order_id}/close.jsonCloses an order
/admin/api/2020-01/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/2020-01/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/2020-01/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/2020-01/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/2020-01/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/2020-04/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/2020-04/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/2020-04/customers/{customer_id}.jsonUpdates a customer.
/admin/api/2020-04/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/2020-04/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/2020-04/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/2020-04/orders/{order_id}/close.jsonCloses an order
/admin/api/2020-04/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/2020-04/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/2020-04/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/2020-04/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/2020-04/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/2020-07/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/2020-07/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/2020-07/customers/{customer_id}.jsonUpdates a customer.
/admin/api/2020-07/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/2020-07/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/2020-07/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/2020-07/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/2020-07/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/2020-07/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/2020-07/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/2020-07/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/2020-10/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/2020-10/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/2020-10/customers/{customer_id}.jsonUpdates a customer.
/admin/api/2020-10/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/2020-10/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/2020-10/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/2020-10/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/2020-10/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/2020-10/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/2020-10/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/2020-10/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/2021-01/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/2021-01/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/2021-01/customers/{customer_id}.jsonUpdates a customer.
/admin/api/2021-01/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/2021-01/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/2021-01/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/2021-01/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/2021-01/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/2021-01/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/2021-01/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/2021-01/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/unstable/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/unstable/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/unstable/countries/{country_id}.jsonDeletes a country.
/admin/api/2020-01/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/2020-01/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/2020-01/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-01/orders/{order_id}/cancel.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Cancels an order. Orders that have a fulfillment object can't be canceled.
/admin/api/2020-01/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/2020-01/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/2020-01/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/2020-01/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/2020-01/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/2020-01/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/2020-04/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/2020-04/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/2020-04/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-04/orders/{order_id}/cancel.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Cancels an order. Orders that have a fulfillment object can't be canceled.
/admin/api/2020-04/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/2020-04/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/2020-04/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/2020-04/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/2020-04/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/2020-04/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/2020-07/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/2020-07/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/2020-07/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-07/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/2020-07/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/2020-07/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/2020-07/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/2020-07/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/2020-07/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/2020-10/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/2020-10/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/2020-10/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-10/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/2020-10/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/2020-10/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/2020-10/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/2020-10/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/2020-10/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/2021-01/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/2021-01/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/2021-01/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2021-01/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/2021-01/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/2021-01/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/2021-01/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/2021-01/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/2021-01/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/unstable/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/unstable/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/unstable/customers/{customer_id}.jsonUpdates a customer.
/admin/api/unstable/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/unstable/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/unstable/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/unstable/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/unstable/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/unstable/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/unstable/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/unstable/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/2020-01/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/2020-01/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/2020-01/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/2020-01/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/2020-01/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/2020-01/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/2020-01/shopify_payments/disputes.jsonRetrieve all disputes ordered by initiated_at date and time (ISO 8601 format), with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/2020-04/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/2020-04/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/2020-04/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/2020-04/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/2020-04/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/2020-04/shopify_payments/disputes.jsonRetrieve all disputes ordered by initiated_at date and time (ISO 8601 format), with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/2020-07/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/2020-07/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/2020-07/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/2020-07/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/2020-07/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/2020-10/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/2020-10/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/2020-10/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/2020-10/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/2020-10/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/2020-10/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/2021-01/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/2021-01/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/2021-01/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/2021-01/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/2021-01/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/2021-01/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/unstable/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/unstable/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/unstable/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/unstable/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/unstable/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/unstable/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/unstable/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/unstable/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/unstable/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/2020-01/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/2020-01/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/2020-01/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/2020-01/comments/{comment_id}/spam.jsonMarks a comment as spam
/admin/api/2020-04/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/2020-04/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/2020-04/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/2020-07/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/2020-07/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/2020-07/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/2020-10/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/2020-10/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/2020-10/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/2021-01/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/2021-01/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/2021-01/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/unstable/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/unstable/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/unstable/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/unstable/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/unstable/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/unstable/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/2020-01/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/2020-01/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/2020-01/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/2020-01/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/2020-01/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/2020-04/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/2020-04/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/2020-04/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/2020-04/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/2020-04/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/2020-07/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/2020-07/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/2020-07/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/2020-07/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/2020-07/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/2020-10/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/2020-10/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/2020-10/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/2020-10/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/2020-10/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/2021-01/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/2021-01/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/2021-01/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/2021-01/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/2021-01/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/unstable/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/unstable/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/unstable/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/2020-01/comments/{comment_id}/remove.jsonRemoves a comment
/admin/api/2020-01/product_listings/product_ids.jsonRetrieve product_ids that are published to your app. Maximum 1,000 results per page.
/admin/api/2020-01/products/{product_id}/images.jsonGet all product images
/admin/api/2020-01/products/{product_id}/images.jsonCreate a new product image
/admin/api/2020-04/product_listings/product_ids.jsonRetrieve product_ids that are published to your app. Maximum 1,000 results per page.
/admin/api/2020-04/products/{product_id}/images.jsonGet all product images
/admin/api/2020-04/products/{product_id}/images.jsonCreate a new product image
/admin/api/2020-07/product_listings/product_ids.jsonRetrieve product_ids that are published to your app. Maximum 1,000 results per page.
/admin/api/2020-07/products/{product_id}/images.jsonGet all product images
/admin/api/2020-07/products/{product_id}/images.jsonCreate a new product image
/admin/api/2020-10/products/{product_id}/images.jsonGet all product images
/admin/api/2020-10/products/{product_id}/images.jsonCreate a new product image
/admin/api/2021-01/products/{product_id}/images.jsonGet all product images
/admin/api/2021-01/products/{product_id}/images.jsonCreate a new product image
/admin/api/unstable/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/unstable/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/unstable/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/unstable/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/unstable/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/2020-01/comments/{comment_id}/approve.jsonApproves a comment
/admin/api/2020-01/comments/{comment_id}/restore.jsonRestores a previously removed comment
/admin/api/2020-01/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/2020-01/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/2020-01/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/2020-04/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/2020-04/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/2020-04/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/2020-07/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/2020-07/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/2020-07/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/2020-10/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/2020-10/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/2020-10/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/2021-01/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/2021-01/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/2021-01/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/unstable/products/{product_id}/images.jsonGet all product images
/admin/api/unstable/products/{product_id}/images.jsonCreate a new product image
/admin/api/2020-01/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/2020-01/comments/{comment_id}/not_spam.jsonMarks a comment as not spam
/admin/api/2020-01/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/2020-01/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/2020-04/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/2020-04/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/2020-04/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/2020-07/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/2020-07/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/2020-07/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/2020-10/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/2020-10/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/2020-10/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/2021-01/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/2021-01/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/2021-01/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/unstable/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/unstable/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/unstable/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/unstable/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/unstable/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/unstable/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/2020-01/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/2020-01/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/2020-01/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/2020-04/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/2020-04/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/2020-04/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/2020-07/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/2020-07/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/2020-07/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/2020-10/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/2020-10/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/2020-10/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/2021-01/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/2021-01/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/2021-01/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/unstable/fulfillment_orders/release_hold.jsonReleases the fulfillment order holds for a specific order. Fulfillment orders are created with an ON_HOLD status if the channel that created the order has a fulfillment hold policy.
/admin/api/2020-01/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/2020-01/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/2020-01/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/2020-04/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/2020-04/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/2020-04/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/2020-07/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/2020-07/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/2020-07/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/2020-10/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/2020-10/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/2020-10/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/2021-01/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/2021-01/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/2021-01/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/unstable/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/unstable/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/unstable/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/2020-01/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/2020-04/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/2020-07/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/2020-10/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/2021-01/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/unstable/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/unstable/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/unstable/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/unstable/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/unstable/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/unstable/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/2020-01/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/2020-01/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/2020-01/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/2020-01/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/2020-04/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/2020-04/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/2020-04/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/2020-04/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/2020-07/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/2020-07/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/2020-07/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/2020-07/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/2020-10/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/2020-10/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/2020-10/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/2020-10/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/2021-01/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/2021-01/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/2021-01/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/2021-01/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/unstable/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/2020-01/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/2020-01/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/2020-01/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/2020-01/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/2020-01/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/2020-04/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/2020-04/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/2020-04/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/2020-04/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/2020-04/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/2020-07/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/2020-07/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/2020-07/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/2020-07/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/2020-07/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/2020-10/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/2020-10/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/2020-10/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/2020-10/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/2020-10/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/2021-01/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/2021-01/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/2021-01/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/2021-01/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/2021-01/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/unstable/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/unstable/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/unstable/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/unstable/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/2020-01/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/2020-01/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/2020-01/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/2020-01/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/2020-01/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/2020-01/product_listings/{product_listing_id}.jsonRetrieve a specific product listing that is published to your app
/admin/api/2020-01/product_listings/{product_listing_id}.jsonCreate a product listing to publish a product to your app
/admin/api/2020-01/product_listings/{product_listing_id}.jsonDelete a product listing to unpublish a product from your app
/admin/api/2020-01/shopify_payments/balance/transactions.jsonRetrieves a list of all balance transactions ordered by processing time, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/2020-04/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/2020-04/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/2020-04/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/2020-04/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/2020-04/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/2020-04/product_listings/{product_listing_id}.jsonRetrieve a specific product listing that is published to your app
/admin/api/2020-04/product_listings/{product_listing_id}.jsonCreate a product listing to publish a product to your app
/admin/api/2020-04/product_listings/{product_listing_id}.jsonDelete a product listing to unpublish a product from your app
/admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/2020-07/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/2020-07/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/2020-07/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/2020-07/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/2020-07/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/2020-07/product_listings/{product_listing_id}.jsonRetrieve a specific product listing that is published to your app
/admin/api/2020-07/product_listings/{product_listing_id}.jsonCreate a product listing to publish a product to your app
/admin/api/2020-07/product_listings/{product_listing_id}.jsonDelete a product listing to unpublish a product from your app
/admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/2020-10/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/2020-10/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/2020-10/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/2020-10/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/2020-10/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/2021-01/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/2021-01/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/2021-01/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/2021-01/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/2021-01/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/unstable/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/unstable/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/unstable/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/unstable/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/unstable/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/2020-01/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/2020-01/shopify_payments/disputes/{dispute_id}.jsonRetrieves a single dispute by ID.
/admin/api/2020-04/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/2020-07/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/2020-10/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/2021-01/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/unstable/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/unstable/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/unstable/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/unstable/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/unstable/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/unstable/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/unstable/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/unstable/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/2020-01/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/2020-01/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/2020-01/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/2020-01/products/{product_id}/images/{image_id}.json/admin/api/2020-01/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/2020-01/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/2020-01/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/2020-04/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/2020-04/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/2020-04/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/2020-04/products/{product_id}/images/{image_id}.json/admin/api/2020-04/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/2020-04/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/2020-04/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/2020-07/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/2020-07/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/2020-07/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/2020-07/products/{product_id}/images/{image_id}.json/admin/api/2020-07/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/2020-07/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/2020-07/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/2020-10/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/2020-10/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/2020-10/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/2020-10/products/{product_id}/images/{image_id}.json/admin/api/2020-10/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/2020-10/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/2020-10/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/2021-01/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/2021-01/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/2021-01/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/2021-01/products/{product_id}/images/{image_id}.json/admin/api/2021-01/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/2021-01/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/2021-01/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/unstable/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/2020-01/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/unstable/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/unstable/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/unstable/products/{product_id}/images/{image_id}.json/admin/api/unstable/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/unstable/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/unstable/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/2020-01/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/2020-01/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/2020-01/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/2020-04/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/2020-04/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/2020-04/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/2020-07/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/2020-07/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/2020-07/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/2020-10/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/2020-10/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/2020-10/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/2021-01/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/2021-01/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/2021-01/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/unstable/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/unstable/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/unstable/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/unstable/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/2020-01/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/2020-01/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/2020-01/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/2020-01/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/2020-01/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/2020-04/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/2020-04/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/2020-04/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/2020-04/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/2020-04/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/2020-07/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/2020-07/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/2020-07/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/2020-07/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/2020-07/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/2020-10/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/2020-10/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/2020-10/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/2020-10/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/2020-10/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/2021-01/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/2021-01/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/2021-01/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/2021-01/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/2021-01/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/unstable/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/unstable/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/unstable/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/unstable/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/unstable/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/unstable/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-01/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/2020-01/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-04/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/2020-04/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/2020-07/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-07/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-07/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-07/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/2020-07/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/2020-10/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-10/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-10/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-10/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/2020-10/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/2021-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2021-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2021-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2021-01/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/2021-01/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/2020-01/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/2020-01/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/2020-01/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/2020-04/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/2020-04/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/2020-04/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/2020-07/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/2020-07/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/2020-07/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/2020-10/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/2020-10/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/2020-10/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/2021-01/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/2021-01/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/2021-01/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/open.jsonMarks a scheduled fulfillment order as ready for fulfillment. This endpoint allows merchants to work on a scheduled fulfillment order before its expected fulfill_at datetime.
/admin/api/unstable/fulfillment_services/{fulfillment_service_id}.json/admin/api/unstable/fulfillment_services/{fulfillment_service_id}.json/admin/api/unstable/fulfillment_services/{fulfillment_service_id}.json/admin/api/unstable/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/unstable/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/unstable/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/unstable/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/unstable/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/open.jsonMarks a scheduled fulfillment order as ready for fulfillment. This endpoint allows merchants to work on a scheduled fulfillment order before its expected fulfill_at datetime.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/2020-01/application_charges/{application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. "Activates an accepted application charge. One-time charges are now immediately activated when approved by a merchant.
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2020-04/application_charges/{application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. "Activates an accepted application charge. One-time charges are now immediately activated when approved by a merchant.
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2020-07/application_charges/{application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. "Activates an accepted application charge. One-time charges are now immediately activated when approved by a merchant.
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2020-10/application_charges/{application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. "Activates an accepted application charge. One-time charges are now immediately activated when approved by a merchant.
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/reschedule.jsonUpdates the fulfill_at time of a scheduled fulfillment order. This endpoint is used to manage the time a scheduled fulfillment order will be marked as ready for fulfillment.
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2020-01/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/2020-04/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/2020-07/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/2020-10/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/2021-01/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/reschedule.jsonUpdates the fulfill_at time of a scheduled fulfillment order. This endpoint is used to manage the time a scheduled fulfillment order will be marked as ready for fulfillment.
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/unstable/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/2020-01/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/unstable/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. Activates a previously accepted recurring application charge. Recurring charges are now immediately activated when approved by a merchant.
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. Activates a previously accepted recurring application charge. Recurring charges are now immediately activated when approved by a merchant.
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. Activates a previously accepted recurring application charge. Recurring charges are now immediately activated when approved by a merchant.
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. Activates a previously accepted recurring application charge. Recurring charges are now immediately activated when approved by a merchant.
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
REST Admin API for managing products, orders, customers, and more.
https://shopify.com1473 endpoints available
/fetch_stockGet inventory levels
/fetch_tracking_numbersGet tracking numbers for orders
/admin/api/2020-01/shop.jsonRetrieves the shop's configuration
/admin/api/2020-04/shop.jsonRetrieves the shop's configuration
/admin/api/2020-07/shop.jsonRetrieves the shop's configuration
/admin/api/2020-10/shop.jsonRetrieves the shop's configuration
/admin/api/2021-01/shop.jsonRetrieves the shop's configuration
/admin/api/2020-01/blogs.jsonRetrieve a list of all blogs. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/blogs.jsonCreate a new blog
/admin/api/2020-01/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/shop.jsonRetrieves the shop's configuration
/admin/api/2020-01/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders.jsonRetrieves a list of orders. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders.jsonCreates an order. By default, product inventory is not claimed. When you create an order, you can include the following option parameters in the body of the request: inventory_behaviour: The behaviour to use when updating inventory. (default: bypass) bypass: Do not claim inventory. decrement_ignoring_policy: Ignore the product's inventory policy and claim inventory. decrement_obeying_policy: Follow the product's inventory policy and claim inventory, if possible. send_receipt: Whether to send an order confirmation to the customer. Note If you're working on a private app and order confirmations are still being sent to the customer when send_receipt is set to false, then you need to disable the Storefront API from the private app's page in the Shopify admin. send_fulfillment_receipt: Whether to send a shipping confirmation to the customer. Note If you are including shipping_address or billing_address, make sure to pass both first_name and last_name. Otherwise both these addresses will be ignored. If you're using this endpoint with a trial or Partner development store, then you can create no more than 5 new orders per minute.
/admin/api/2020-01/themes.jsonRetrieves a list of themes.
/admin/api/2020-01/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/api/2020-04/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders.jsonRetrieves a list of orders. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders.jsonCreates an order. By default, product inventory is not claimed. When you create an order, you can include the following option parameters in the body of the request: inventory_behaviour: The behaviour to use when updating inventory. (default: bypass) bypass: Do not claim inventory. decrement_ignoring_policy: Ignore the product's inventory policy and claim inventory. decrement_obeying_policy: Follow the product's inventory policy and claim inventory, if possible. send_receipt: Whether to send an order confirmation to the customer. Note If you're working on a private app and order confirmations are still being sent to the customer when send_receipt is set to false, then you need to disable the Storefront API from the private app's page in the Shopify admin. send_fulfillment_receipt: Whether to send a shipping confirmation to the customer. Note If you are including shipping_address or billing_address, make sure to pass both first_name and last_name. Otherwise both these addresses will be ignored. If you're using this endpoint with a trial or Partner development store, then you can create no more than 5 new orders per minute.
/admin/api/2020-04/themes.jsonRetrieves a list of themes.
/admin/api/2020-04/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/api/2020-07/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/orders.jsonRetrieves a list of orders. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/themes.jsonRetrieves a list of themes.
/admin/api/2020-07/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/api/2020-10/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/themes.jsonRetrieves a list of themes.
/admin/api/2020-10/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/api/2021-01/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/themes.jsonRetrieves a list of themes.
/admin/api/2021-01/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/api/unstable/users.jsonRetrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/reports.jsonCreates a new report
/admin/api/2020-04/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/reports.jsonCreates a new report
/admin/api/2020-07/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/reports.jsonCreates a new report
/admin/api/2020-10/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/reports.jsonCreates a new report
/admin/api/2021-01/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/reports.jsonCreates a new report
/admin/api/unstable/events.jsonRetrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/themes.jsonRetrieves a list of themes.
/admin/api/unstable/themes.jsonCreates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes.
/admin/oauth/access_scopes.jsonRetrieves a list of access scopes associated to the access token.
/admin/api/2020-01/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/collects.jsonAdds a product to a custom collection.
/admin/api/2020-01/comments.jsonRetrieves a list of comments. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/comments.jsonCreates a comment for an article
/admin/api/2020-01/policies.jsonRetrieves a list of the shop's policies
/admin/api/2020-01/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-01/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/2020-04/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/collects.jsonAdds a product to a custom collection.
/admin/api/2020-04/policies.jsonRetrieves a list of the shop's policies
/admin/api/2020-04/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-04/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/2020-07/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/collects.jsonAdds a product to a custom collection.
/admin/api/2020-07/policies.jsonRetrieves a list of the shop's policies
/admin/api/2020-07/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-07/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/2020-10/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/collects.jsonAdds a product to a custom collection.
/admin/api/2020-10/policies.jsonRetrieves a list of the shop's policies
/admin/api/2020-10/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-10/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/2021-01/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/collects.jsonAdds a product to a custom collection.
/admin/api/2021-01/policies.jsonRetrieves a list of the shop's policies
/admin/api/2021-01/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2021-01/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/unstable/reports.jsonRetrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/reports.jsonCreates a new report
/admin/api/2020-01/checkouts.jsonCreates a checkout
/admin/api/2020-01/countries.jsonRetrieves a list of countries.
/admin/api/2020-01/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/2020-01/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/customers.jsonCreates a customer.
/admin/api/2020-01/locations.jsonRetrieves a list of locations
/admin/api/2020-01/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/2020-04/checkouts.jsonCreates a checkout
/admin/api/2020-04/countries.jsonRetrieves a list of countries.
/admin/api/2020-04/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/2020-04/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/customers.jsonCreates a customer.
/admin/api/2020-04/locations.jsonRetrieves a list of locations
/admin/api/2020-04/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/2020-07/checkouts.jsonCreates a checkout
/admin/api/2020-07/countries.jsonRetrieves a list of countries.
/admin/api/2020-07/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/2020-07/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/customers.jsonCreates a customer.
/admin/api/2020-07/locations.jsonRetrieves a list of locations
/admin/api/2020-07/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/2020-10/checkouts.jsonCreates a checkout
/admin/api/2020-10/countries.jsonRetrieves a list of countries.
/admin/api/2020-10/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/2020-10/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/customers.jsonCreates a customer.
/admin/api/2020-10/locations.jsonRetrieves a list of locations
/admin/api/2020-10/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/2021-01/checkouts.jsonCreates a checkout
/admin/api/2021-01/countries.jsonRetrieves a list of countries.
/admin/api/2021-01/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/2021-01/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/customers.jsonCreates a customer.
/admin/api/2021-01/locations.jsonRetrieves a list of locations
/admin/api/2021-01/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/unstable/collects.jsonRetrieves a list of collects. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/collects.jsonAdds a product to a custom collection.
/admin/api/unstable/policies.jsonRetrieves a list of the shop's policies
/admin/api/unstable/products.jsonRetrieves a list of products. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/products.jsonCreates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/unstable/webhooks.jsonRetrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/webhooks.jsonCreate a new webhook subscription by specifying both an address and a topic
/admin/api/2020-01/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/2020-01/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/gift_cards.jsonCreates a gift card
/admin/api/2020-01/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/2020-01/metafields.jsonCreates a new metafield for a resource.
/admin/api/2020-04/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/2020-04/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/gift_cards.jsonCreates a gift card
/admin/api/2020-04/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/2020-04/metafields.jsonCreates a new metafield for a resource.
/admin/api/2020-07/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/2020-07/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/gift_cards.jsonCreates a gift card
/admin/api/2020-07/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/2020-07/metafields.jsonCreates a new metafield for a resource.
/admin/api/2020-10/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/2020-10/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/gift_cards.jsonCreates a gift card
/admin/api/2020-10/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/2020-10/metafields.jsonCreates a new metafield for a resource.
/admin/api/2021-01/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/2021-01/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/gift_cards.jsonCreates a gift card
/admin/api/2021-01/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/2021-01/metafields.jsonCreates a new metafield for a resource.
/admin/api/unstable/checkouts.jsonCreates a checkout
/admin/api/unstable/countries.jsonRetrieves a list of countries.
/admin/api/unstable/countries.jsonCaution As of version 2020-10, the tax field is deprecated. Creates a country.
/admin/api/unstable/customers.jsonRetrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/customers.jsonCreates a customer.
/admin/api/unstable/locations.jsonRetrieves a list of locations
/admin/api/unstable/redirects.jsonRetrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/redirects.jsonCreates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": "http://www.johns-apparel.com/springwear" will be saved as "path": "springwear".
/admin/api/2020-01/blogs/count.jsonGet a count of all blogs
/admin/api/2020-01/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/script_tags.jsonCreates a new script tag
/admin/api/2020-04/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/script_tags.jsonCreates a new script tag
/admin/api/2020-07/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/script_tags.jsonCreates a new script tag
/admin/api/2020-10/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/script_tags.jsonCreates a new script tag
/admin/api/2021-01/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/script_tags.jsonCreates a new script tag
/admin/api/unstable/currencies.jsonRetrieves a list of currencies enabled on a shop
/admin/api/unstable/gift_cards.jsonRetrieves a list of gift cards. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/gift_cards.jsonCreates a gift card
/admin/api/unstable/metafields.jsonRetrieves a list of metafields that belong to a Product Image resource.
/admin/api/unstable/metafields.jsonCreates a new metafield for a resource.
/admin/api/2020-01/events/count.jsonRetrieves a count of events
/admin/api/2020-01/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/2020-01/orders/count.jsonRetrieves an order count
/admin/api/2020-04/events/count.jsonRetrieves a count of events
/admin/api/2020-04/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/2020-04/orders/count.jsonRetrieves an order count
/admin/api/2020-07/events/count.jsonRetrieves a count of events
/admin/api/2020-07/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/2020-10/events/count.jsonRetrieves a count of events
/admin/api/2020-10/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/2021-01/events/count.jsonRetrieves a count of events
/admin/api/2021-01/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/unstable/script_tags.jsonRetrieves a list of all script tags. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/script_tags.jsonCreates a new script tag
/admin/api/2020-01/articles/tags.jsonRetrieves a list of all the tags
/admin/api/2020-01/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/2020-04/articles/tags.jsonRetrieves a list of all the tags
/admin/api/2020-04/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/2020-07/articles/tags.jsonRetrieves a list of all the tags
/admin/api/2020-07/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/2020-10/articles/tags.jsonRetrieves a list of all the tags
/admin/api/2020-10/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/2021-01/articles/tags.jsonRetrieves a list of all the tags
/admin/api/2021-01/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/unstable/events/count.jsonRetrieves a count of events
/admin/api/unstable/fulfillments.jsonCreates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
/admin/api/2020-01/collects/count.jsonRetrieves a count of collects.
/admin/api/2020-01/comments/count.jsonRetrieves a count of comments
/admin/api/2020-01/products/count.jsonRetrieves a count of products.
/admin/api/2020-01/shipping_zones.jsonGet a list of all shipping zones
/admin/api/2020-01/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/2020-04/collects/count.jsonRetrieves a count of collects.
/admin/api/2020-04/products/count.jsonRetrieves a count of products.
/admin/api/2020-04/shipping_zones.jsonGet a list of all shipping zones
/admin/api/2020-04/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/2020-07/collects/count.jsonRetrieves a count of collects.
/admin/api/2020-07/products/count.jsonRetrieves a count of products.
/admin/api/2020-07/shipping_zones.jsonGet a list of all shipping zones
/admin/api/2020-07/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/2020-10/collects/count.jsonRetrieves a count of collects.
/admin/api/2020-10/products/count.jsonRetrieves a count of products.
/admin/api/2020-10/shipping_zones.jsonGet a list of all shipping zones
/admin/api/2020-10/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/2021-01/collects/count.jsonRetrieves a count of collects.
/admin/api/2021-01/products/count.jsonRetrieves a count of products.
/admin/api/2021-01/shipping_zones.jsonGet a list of all shipping zones
/admin/api/2021-01/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/unstable/articles/tags.jsonRetrieves a list of all the tags
/admin/api/unstable/users/current.jsonRetrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.
/admin/api/2020-01/blogs/{blog_id}.jsonGet a single blog by its ID
/admin/api/2020-01/blogs/{blog_id}.jsonUpdate a blog
/admin/api/2020-01/blogs/{blog_id}.jsonDelete a blog
/admin/api/2020-01/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/2020-01/countries/count.jsonRetrieves a count of countries.
/admin/api/2020-01/customers/count.jsonRetrieves a count of all customers.
/admin/api/2020-01/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/locations/count.jsonRetrieves a count of locations
/admin/api/2020-01/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/2020-01/users/{user_id}.jsonRetrieves a single user
/admin/api/2020-04/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/2020-04/countries/count.jsonRetrieves a count of countries.
/admin/api/2020-04/customers/count.jsonRetrieves a count of all customers.
/admin/api/2020-04/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/locations/count.jsonRetrieves a count of locations
/admin/api/2020-04/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/2020-04/users/{user_id}.jsonRetrieves a single user
/admin/api/2020-07/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/2020-07/countries/count.jsonRetrieves a count of countries.
/admin/api/2020-07/customers/count.jsonRetrieves a count of all customers.
/admin/api/2020-07/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/locations/count.jsonRetrieves a count of locations
/admin/api/2020-07/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/2020-07/users/{user_id}.jsonRetrieves a single user
/admin/api/2020-10/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/2020-10/countries/count.jsonRetrieves a count of countries.
/admin/api/2020-10/customers/count.jsonRetrieves a count of all customers.
/admin/api/2020-10/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/locations/count.jsonRetrieves a count of locations
/admin/api/2020-10/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/2020-10/users/{user_id}.jsonRetrieves a single user
/admin/api/2021-01/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/2021-01/countries/count.jsonRetrieves a count of countries.
/admin/api/2021-01/customers/count.jsonRetrieves a count of all customers.
/admin/api/2021-01/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/locations/count.jsonRetrieves a count of locations
/admin/api/2021-01/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/2021-01/users/{user_id}.jsonRetrieves a single user
/admin/api/unstable/collects/count.jsonRetrieves a count of collects.
/admin/api/unstable/products/count.jsonRetrieves a count of products.
/admin/api/unstable/shipping_zones.jsonGet a list of all shipping zones
/admin/api/unstable/webhooks/count.jsonRetrieves a count of existing webhook subscriptions
/admin/api/2020-01/articles/authors.jsonRetrieves a list all of article authors
/admin/api/2020-01/carrier_services.jsonRetrieves a list of carrier services
/admin/api/2020-01/carrier_services.jsonCreates a carrier service
/admin/api/2020-01/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/2020-01/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/2020-01/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/2020-01/product_listings.jsonRetrieve product listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/articles/authors.jsonRetrieves a list all of article authors
/admin/api/2020-04/carrier_services.jsonRetrieves a list of carrier services
/admin/api/2020-04/carrier_services.jsonCreates a carrier service
/admin/api/2020-04/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/2020-04/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/2020-04/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/2020-04/product_listings.jsonRetrieve product listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/articles/authors.jsonRetrieves a list all of article authors
/admin/api/2020-07/carrier_services.jsonRetrieves a list of carrier services
/admin/api/2020-07/carrier_services.jsonCreates a carrier service
/admin/api/2020-07/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/2020-07/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/2020-07/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/2020-07/product_listings.jsonRetrieve product listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/articles/authors.jsonRetrieves a list all of article authors
/admin/api/2020-10/carrier_services.jsonRetrieves a list of carrier services
/admin/api/2020-10/carrier_services.jsonCreates a carrier service
/admin/api/2020-10/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/2020-10/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/2020-10/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/2021-01/articles/authors.jsonRetrieves a list all of article authors
/admin/api/2021-01/carrier_services.jsonRetrieves a list of carrier services
/admin/api/2021-01/carrier_services.jsonCreates a carrier service
/admin/api/2021-01/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/2021-01/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/2021-01/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/unstable/checkouts/count.jsonRetrieves a count of checkouts from the past 90 days
/admin/api/unstable/countries/count.jsonRetrieves a count of countries.
/admin/api/unstable/customers/count.jsonRetrieves a count of all customers.
/admin/api/unstable/inventory_items.jsonRetrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/locations/count.jsonRetrieves a count of locations
/admin/api/unstable/redirects/count.jsonRetrieves a count of URL redirects
/admin/api/unstable/users/{user_id}.jsonRetrieves a single user
/admin/api/2020-01/checkouts/{token}.jsonRetrieves a checkout
/admin/api/2020-01/checkouts/{token}.jsonModifies an existing checkout
/admin/api/2020-01/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/2020-01/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders/{order_id}.jsonRetrieves a specific order
/admin/api/2020-01/orders/{order_id}.jsonUpdates an order
/admin/api/2020-01/orders/{order_id}.jsonDeletes an order. Orders that interact with an online gateway can't be deleted.
/admin/api/2020-01/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/2020-01/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/2020-01/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/2020-01/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/2020-01/themes/{theme_id}.jsonDeletes a theme.
/admin/api/2020-04/checkouts/{token}.jsonRetrieves a checkout
/admin/api/2020-04/checkouts/{token}.jsonModifies an existing checkout
/admin/api/2020-04/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/2020-04/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders/{order_id}.jsonRetrieves a specific order
/admin/api/2020-04/orders/{order_id}.jsonUpdates an order
/admin/api/2020-04/orders/{order_id}.jsonDeletes an order. Orders that interact with an online gateway can't be deleted.
/admin/api/2020-04/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/2020-04/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/2020-04/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/2020-04/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/2020-04/themes/{theme_id}.jsonDeletes a theme.
/admin/api/2020-07/checkouts/{token}.jsonRetrieves a checkout
/admin/api/2020-07/checkouts/{token}.jsonModifies an existing checkout
/admin/api/2020-07/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/2020-07/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/2020-07/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/2020-07/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/2020-07/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/2020-07/themes/{theme_id}.jsonDeletes a theme.
/admin/api/2020-10/checkouts/{token}.jsonRetrieves a checkout
/admin/api/2020-10/checkouts/{token}.jsonModifies an existing checkout
/admin/api/2020-10/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/2020-10/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/2020-10/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/2020-10/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/2020-10/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/2020-10/themes/{theme_id}.jsonDeletes a theme.
/admin/api/2021-01/checkouts/{token}.jsonRetrieves a checkout
/admin/api/2021-01/checkouts/{token}.jsonModifies an existing checkout
/admin/api/2021-01/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/2021-01/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/2021-01/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/2021-01/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/2021-01/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/2021-01/themes/{theme_id}.jsonDeletes a theme.
/admin/api/unstable/articles/authors.jsonRetrieves a list all of article authors
/admin/api/unstable/carrier_services.jsonRetrieves a list of carrier services
/admin/api/unstable/carrier_services.jsonCreates a carrier service
/admin/api/unstable/customers/search.jsonSearches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/gift_cards/count.jsonRetrieves a count of gift cards
/admin/api/unstable/inventory_levels.jsonRetrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/inventory_levels.jsonDeletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.
/admin/api/unstable/metafields/count.jsonRetrieves a count of a resource's metafields.
/admin/api/2020-01/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/custom_collections.jsonCreates a custom collection
/admin/api/2020-04/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/custom_collections.jsonCreates a custom collection
/admin/api/2020-07/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/custom_collections.jsonCreates a custom collection
/admin/api/2020-10/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/custom_collections.jsonCreates a custom collection
/admin/api/2021-01/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/custom_collections.jsonCreates a custom collection
/admin/api/unstable/checkouts/{token}.jsonRetrieves a checkout
/admin/api/unstable/checkouts/{token}.jsonModifies an existing checkout
/admin/api/unstable/events/{event_id}.jsonRetrieves a single event by its ID
/admin/api/unstable/gift_cards/search.jsonSearches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/script_tags/count.jsonRetrieves a count of all script tags
/admin/api/unstable/smart_collections.jsonRetrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/smart_collections.jsonCreates a new smart collection using the specified rules.
/admin/api/unstable/themes/{theme_id}.jsonRetrieves a single theme.
/admin/api/unstable/themes/{theme_id}.jsonUpdates an existing theme.
/admin/api/unstable/themes/{theme_id}.jsonDeletes a theme.
/admin/api/2020-01/application_charges.jsonRetrieves a list of application charges
/admin/api/2020-01/application_charges.jsonCreates an application charge
/admin/api/2020-01/application_credits.jsonRetrieves all application credits
/admin/api/2020-01/application_credits.jsonCreates an application credit
/admin/api/2020-01/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/2020-01/reports/{report_id}.jsonUpdates a report
/admin/api/2020-01/reports/{report_id}.jsonDeletes a report
/admin/api/2020-01/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/application_charges.jsonRetrieves a list of application charges
/admin/api/2020-04/application_charges.jsonCreates an application charge
/admin/api/2020-04/application_credits.jsonRetrieves all application credits
/admin/api/2020-04/application_credits.jsonCreates an application credit
/admin/api/2020-04/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/2020-04/reports/{report_id}.jsonUpdates a report
/admin/api/2020-04/reports/{report_id}.jsonDeletes a report
/admin/api/2020-04/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/application_charges.jsonRetrieves a list of application charges
/admin/api/2020-07/application_charges.jsonCreates an application charge
/admin/api/2020-07/application_credits.jsonRetrieves all application credits
/admin/api/2020-07/application_credits.jsonCreates an application credit
/admin/api/2020-07/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/2020-07/reports/{report_id}.jsonUpdates a report
/admin/api/2020-07/reports/{report_id}.jsonDeletes a report
/admin/api/2020-07/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/application_charges.jsonRetrieves a list of application charges
/admin/api/2020-10/application_charges.jsonCreates an application charge
/admin/api/2020-10/application_credits.jsonRetrieves all application credits
/admin/api/2020-10/application_credits.jsonCreates an application credit
/admin/api/2020-10/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/2020-10/reports/{report_id}.jsonUpdates a report
/admin/api/2020-10/reports/{report_id}.jsonDeletes a report
/admin/api/2020-10/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/application_charges.jsonRetrieves a list of application charges
/admin/api/2021-01/application_charges.jsonCreates an application charge
/admin/api/2021-01/application_credits.jsonRetrieves all application credits
/admin/api/2021-01/application_credits.jsonCreates an application credit
/admin/api/2021-01/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/2021-01/reports/{report_id}.jsonUpdates a report
/admin/api/2021-01/reports/{report_id}.jsonDeletes a report
/admin/api/2021-01/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/custom_collections.jsonRetrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/custom_collections.jsonCreates a custom collection
/admin/api/2020-01/fulfillment_services.json/admin/api/2020-01/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/2020-01/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-04/fulfillment_services.json/admin/api/2020-04/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/2020-04/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-07/fulfillment_services.json/admin/api/2020-07/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/2020-07/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-10/fulfillment_services.json/admin/api/2020-10/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/2020-10/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2021-01/deprecated_api_calls.jsonRetrieves a list of deprecated API calls made by the authenticated private app in the past 30 days.
/admin/api/2021-01/fulfillment_services.json/admin/api/2021-01/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/2021-01/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/unstable/application_charges.jsonRetrieves a list of application charges
/admin/api/unstable/application_charges.jsonCreates an application charge
/admin/api/unstable/application_credits.jsonRetrieves all application credits
/admin/api/unstable/application_credits.jsonCreates an application credit
/admin/api/unstable/collection_listings.jsonRetrieve collection listings that are published to your app. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/reports/{report_id}.jsonRetrieves a single report created by your app
/admin/api/unstable/reports/{report_id}.jsonUpdates a report
/admin/api/unstable/reports/{report_id}.jsonDeletes a report
/admin/api/unstable/tender_transactions.jsonRetrieves a list of tender transactions. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/2020-01/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/2020-01/comments/{comment_id}.jsonRetrieves a single comment by its ID
/admin/api/2020-01/comments/{comment_id}.jsonUpdates a comment of an article
/admin/api/2020-01/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/2020-01/products/{product_id}.jsonRetrieves a single product.
/admin/api/2020-01/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-01/products/{product_id}.jsonDeletes a product.
/admin/api/2020-01/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/2020-01/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/2020-01/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/2020-04/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/2020-04/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/2020-04/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/2020-04/products/{product_id}.jsonRetrieves a single product.
/admin/api/2020-04/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-04/products/{product_id}.jsonDeletes a product.
/admin/api/2020-04/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/2020-04/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/2020-04/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/2020-07/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/2020-07/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/2020-07/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/2020-07/products/{product_id}.jsonRetrieves a single product.
/admin/api/2020-07/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-07/products/{product_id}.jsonDeletes a product.
/admin/api/2020-07/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/2020-07/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/2020-07/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/2020-10/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/2020-10/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/2020-10/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/2020-10/products/{product_id}.jsonRetrieves a single product.
/admin/api/2020-10/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2020-10/products/{product_id}.jsonDeletes a product.
/admin/api/2020-10/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/2020-10/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/2020-10/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/2021-01/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/2021-01/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/2021-01/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/2021-01/products/{product_id}.jsonRetrieves a single product.
/admin/api/2021-01/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/2021-01/products/{product_id}.jsonDeletes a product.
/admin/api/2021-01/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/2021-01/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/2021-01/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/unstable/deprecated_api_calls.jsonRetrieves a list of deprecated API calls made by the authenticated private app in the past 30 days.
/admin/api/unstable/fulfillment_services.json/admin/api/unstable/fulfillment_services.jsonTo create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL.
/admin/api/unstable/inventory_levels/set.jsonSets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-01/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/2020-01/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/2020-01/countries/{country_id}.jsonDeletes a country.
/admin/api/2020-01/orders/{order_id}/open.jsonRe-opens a closed order
/admin/api/2020-01/product_listings/count.jsonRetrieve a count of products that are published to your app
/admin/api/2020-04/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/2020-04/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/2020-04/countries/{country_id}.jsonDeletes a country.
/admin/api/2020-04/orders/{order_id}/open.jsonRe-opens a closed order
/admin/api/2020-04/product_listings/count.jsonRetrieve a count of products that are published to your app
/admin/api/2020-07/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/2020-07/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/2020-07/countries/{country_id}.jsonDeletes a country.
/admin/api/2020-07/product_listings/count.jsonRetrieve a count of products that are published to your app
/admin/api/2020-10/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/2020-10/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/2020-10/countries/{country_id}.jsonDeletes a country.
/admin/api/2021-01/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/2021-01/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/2021-01/countries/{country_id}.jsonDeletes a country.
/admin/api/unstable/collects/{collect_id}.jsonRetrieves a specific collect by its ID.
/admin/api/unstable/collects/{collect_id}.jsonRemoves a product from a collection.
/admin/api/unstable/discount_codes/lookup.jsonRetrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
/admin/api/unstable/products/{product_id}.jsonRetrieves a single product.
/admin/api/unstable/products/{product_id}.jsonUpdates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag.
/admin/api/unstable/products/{product_id}.jsonDeletes a product.
/admin/api/unstable/webhooks/{webhook_id}.jsonRetrieves a single webhook subscription
/admin/api/unstable/webhooks/{webhook_id}.jsonUpdate a webhook subscription's topic or address URIs
/admin/api/unstable/webhooks/{webhook_id}.jsonDelete a webhook subscription
/admin/api/2020-01/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/2020-01/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/2020-01/customers/{customer_id}.jsonUpdates a customer.
/admin/api/2020-01/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/2020-01/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/2020-01/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/2020-01/orders/{order_id}/close.jsonCloses an order
/admin/api/2020-01/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/2020-01/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/2020-01/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/2020-01/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/2020-01/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/2020-04/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/2020-04/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/2020-04/customers/{customer_id}.jsonUpdates a customer.
/admin/api/2020-04/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/2020-04/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/2020-04/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/2020-04/orders/{order_id}/close.jsonCloses an order
/admin/api/2020-04/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/2020-04/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/2020-04/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/2020-04/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/2020-04/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/2020-07/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/2020-07/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/2020-07/customers/{customer_id}.jsonUpdates a customer.
/admin/api/2020-07/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/2020-07/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/2020-07/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/2020-07/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/2020-07/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/2020-07/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/2020-07/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/2020-07/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/2020-10/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/2020-10/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/2020-10/customers/{customer_id}.jsonUpdates a customer.
/admin/api/2020-10/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/2020-10/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/2020-10/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/2020-10/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/2020-10/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/2020-10/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/2020-10/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/2020-10/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/2021-01/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/2021-01/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/2021-01/customers/{customer_id}.jsonUpdates a customer.
/admin/api/2021-01/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/2021-01/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/2021-01/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/2021-01/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/2021-01/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/2021-01/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/2021-01/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/2021-01/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/unstable/countries/{country_id}.jsonRetrieves a specific county.
/admin/api/unstable/countries/{country_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing country.
/admin/api/unstable/countries/{country_id}.jsonDeletes a country.
/admin/api/2020-01/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/2020-01/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/2020-01/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-01/orders/{order_id}/cancel.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Cancels an order. Orders that have a fulfillment object can't be canceled.
/admin/api/2020-01/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/2020-01/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/2020-01/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/2020-01/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/2020-01/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/2020-01/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/2020-04/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/2020-04/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/2020-04/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-04/orders/{order_id}/cancel.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Cancels an order. Orders that have a fulfillment object can't be canceled.
/admin/api/2020-04/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/2020-04/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/2020-04/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/2020-04/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/2020-04/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/2020-04/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/2020-07/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/2020-07/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/2020-07/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-07/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/2020-07/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/2020-07/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/2020-07/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/2020-07/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/2020-07/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/2020-10/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/2020-10/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/2020-10/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2020-10/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/2020-10/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/2020-10/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/2020-10/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/2020-10/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/2020-10/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/2021-01/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/2021-01/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/2021-01/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/2021-01/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/2021-01/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/2021-01/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/2021-01/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/2021-01/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/2021-01/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/unstable/customer_saved_searches.jsonRetrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/customer_saved_searches.jsonCreates a customer saved search.
/admin/api/unstable/customers/{customer_id}.jsonRetrieves a single customer.
/admin/api/unstable/customers/{customer_id}.jsonUpdates a customer.
/admin/api/unstable/customers/{customer_id}.jsonDeletes a customer. A customer can't be deleted if they have existing orders.
/admin/api/unstable/inventory_levels/adjust.jsonAdjusts the inventory level of an inventory item at a single location
/admin/api/unstable/locations/{location_id}.jsonRetrieves a single location by its ID
/admin/api/unstable/orders/{order_id}/risks.jsonRetrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/orders/{order_id}/risks.jsonCreates an order risk for an order
/admin/api/unstable/redirects/{redirect_id}.jsonRetrieves a single redirect
/admin/api/unstable/redirects/{redirect_id}.jsonUpdates an existing redirect
/admin/api/unstable/redirects/{redirect_id}.jsonDeletes a redirect
/admin/api/unstable/smart_collections/count.jsonRetrieves a count of smart collections
/admin/api/2020-01/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/2020-01/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/2020-01/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/2020-01/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/2020-01/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/2020-01/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/2020-01/shopify_payments/disputes.jsonRetrieve all disputes ordered by initiated_at date and time (ISO 8601 format), with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/2020-04/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/2020-04/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/2020-04/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/2020-04/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/2020-04/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/2020-04/shopify_payments/disputes.jsonRetrieve all disputes ordered by initiated_at date and time (ISO 8601 format), with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/2020-07/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/2020-07/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/2020-07/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/2020-07/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/2020-07/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/2020-10/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/2020-10/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/2020-10/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/2020-10/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/2020-10/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/2020-10/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/2021-01/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/2021-01/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/2021-01/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/2021-01/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/2021-01/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/2021-01/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/unstable/blogs/{blog_id}/articles.jsonRetrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/blogs/{blog_id}/articles.jsonCreates an article for a blog
/admin/api/unstable/custom_collections/count.jsonRetrieves a count of custom collections
/admin/api/unstable/inventory_levels/connect.jsonConnects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.
/admin/api/unstable/shopify_payments/balance.jsonRetrieves the account's current balance.
/admin/api/unstable/shopify_payments/payouts.jsonRetrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/storefront_access_tokens.jsonRetrieves a list of storefront access tokens that have been issued
/admin/api/unstable/storefront_access_tokens.jsonCreates a new storefront access token
/admin/api/unstable/themes/{theme_id}/assets.jsonRetrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties.
/admin/api/unstable/themes/{theme_id}/assets.jsonCreates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file.
/admin/api/unstable/themes/{theme_id}/assets.jsonDeletes an asset from a theme.
/admin/api/2020-01/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/2020-01/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/2020-01/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/2020-01/comments/{comment_id}/spam.jsonMarks a comment as spam
/admin/api/2020-04/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/2020-04/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/2020-04/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/2020-07/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/2020-07/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/2020-07/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/2020-10/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/2020-10/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/2020-10/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/2021-01/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/2021-01/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/2021-01/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/unstable/gift_cards/{gift_card_id}.jsonRetrieves a single gift card by its ID
/admin/api/unstable/gift_cards/{gift_card_id}.jsonUpdates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix.
/admin/api/unstable/metafields/{metafield_id}.jsonRetrieves a single metafield from a resource by its ID.
/admin/api/unstable/metafields/{metafield_id}.jsonUpdates a metafield.
/admin/api/unstable/metafields/{metafield_id}.jsonDeletes a metafield by its ID.
/admin/api/unstable/orders/{order_id}/refunds.jsonRetrieves a list of refunds for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/orders/{order_id}/refunds.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
/admin/api/2020-01/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/2020-01/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/2020-01/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/2020-01/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/2020-01/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/2020-04/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/2020-04/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/2020-04/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/2020-04/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/2020-04/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/2020-07/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/2020-07/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/2020-07/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/2020-07/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/2020-07/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/2020-10/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/2020-10/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/2020-10/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/2020-10/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/2020-10/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/2021-01/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/2021-01/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/2021-01/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/2021-01/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/2021-01/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/unstable/checkouts/{token}/complete.jsonCompletes a checkout
/admin/api/unstable/checkouts/{token}/payments.jsonRetrieves a list of payments on a particular checkout
/admin/api/unstable/checkouts/{token}/payments.jsonCreates a payment on a checkout using the session ID returned by the card vault
/admin/api/2020-01/comments/{comment_id}/remove.jsonRemoves a comment
/admin/api/2020-01/product_listings/product_ids.jsonRetrieve product_ids that are published to your app. Maximum 1,000 results per page.
/admin/api/2020-01/products/{product_id}/images.jsonGet all product images
/admin/api/2020-01/products/{product_id}/images.jsonCreate a new product image
/admin/api/2020-04/product_listings/product_ids.jsonRetrieve product_ids that are published to your app. Maximum 1,000 results per page.
/admin/api/2020-04/products/{product_id}/images.jsonGet all product images
/admin/api/2020-04/products/{product_id}/images.jsonCreate a new product image
/admin/api/2020-07/product_listings/product_ids.jsonRetrieve product_ids that are published to your app. Maximum 1,000 results per page.
/admin/api/2020-07/products/{product_id}/images.jsonGet all product images
/admin/api/2020-07/products/{product_id}/images.jsonCreate a new product image
/admin/api/2020-10/products/{product_id}/images.jsonGet all product images
/admin/api/2020-10/products/{product_id}/images.jsonCreate a new product image
/admin/api/2021-01/products/{product_id}/images.jsonGet all product images
/admin/api/2021-01/products/{product_id}/images.jsonCreate a new product image
/admin/api/unstable/assigned_fulfillment_orders.jsonRetrieves a list of fulfillment orders on a shop for a specific app.
/admin/api/unstable/collections/{collection_id}.jsonRetrieves a single collection
/admin/api/unstable/script_tags/{script_tag_id}.jsonRetrieves a single script tag
/admin/api/unstable/script_tags/{script_tag_id}.jsonUpdates a script tag
/admin/api/unstable/script_tags/{script_tag_id}.jsonDeletes a script tag
/admin/api/2020-01/comments/{comment_id}/approve.jsonApproves a comment
/admin/api/2020-01/comments/{comment_id}/restore.jsonRestores a previously removed comment
/admin/api/2020-01/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/2020-01/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/2020-01/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/2020-04/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/2020-04/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/2020-04/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/2020-07/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/2020-07/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/2020-07/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/2020-10/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/2020-10/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/2020-10/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/2021-01/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/2021-01/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/2021-01/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/unstable/products/{product_id}/images.jsonGet all product images
/admin/api/unstable/products/{product_id}/images.jsonCreate a new product image
/admin/api/2020-01/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/2020-01/comments/{comment_id}/not_spam.jsonMarks a comment as not spam
/admin/api/2020-01/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/2020-01/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/2020-04/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/2020-04/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/2020-04/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/2020-07/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/2020-07/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/2020-07/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/2020-10/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/2020-10/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/2020-10/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/2021-01/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/2021-01/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/2021-01/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/unstable/customer_saved_searches/count.jsonRetrieves a count of all customer saved searches.
/admin/api/unstable/recurring_application_charges.jsonRetrieves a list of recurring application charges
/admin/api/unstable/recurring_application_charges.jsonCreates a recurring application charge
/admin/api/unstable/blogs/{blog_id}/articles/count.jsonRetrieves a count of all articles from a blog
/admin/api/unstable/customers/{customer_id}/orders.jsonRetrieves all orders belonging to a customer. The query string parameters that are available to the Order resource are also available to this endpoint.
/admin/api/unstable/orders/{order_id}/fulfillments.jsonRetrieves fulfillments associated with an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/orders/{order_id}/fulfillments.jsonCreate a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment.
/admin/api/2020-01/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/2020-01/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/2020-01/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/2020-04/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/2020-04/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/2020-04/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/2020-07/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/2020-07/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/2020-07/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/2020-10/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/2020-10/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/2020-10/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/2021-01/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/2021-01/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/2021-01/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/unstable/fulfillment_orders/release_hold.jsonReleases the fulfillment order holds for a specific order. Fulfillment orders are created with an ON_HOLD status if the channel that created the order has a fulfillment hold policy.
/admin/api/2020-01/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/2020-01/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/2020-01/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/2020-04/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/2020-04/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/2020-04/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/2020-07/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/2020-07/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/2020-07/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/2020-10/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/2020-10/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/2020-10/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/2021-01/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/2021-01/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/2021-01/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/unstable/checkouts/{token}/payments/count.jsonCounts the number of payments attempted on a checkout
/admin/api/unstable/checkouts/{token}/shipping_rates.jsonRetrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate.
/admin/api/unstable/countries/{country_id}/provinces.jsonRetrieves a list of provinces
/admin/api/2020-01/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/2020-04/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/2020-07/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/2020-10/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/2021-01/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/unstable/customers/{customer_id}/addresses.jsonRetrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/customers/{customer_id}/addresses.jsonCreates a new address for a customer.
/admin/api/unstable/gift_cards/{gift_card_id}/disable.jsonDisables a gift card. Disabling a gift card can't be undone.
/admin/api/unstable/orders/{order_id}/risks/{risk_id}.jsonRetrieves a single order risk by its ID
/admin/api/unstable/orders/{order_id}/risks/{risk_id}.jsonUpdates an order risk Note You cannot modify an order risk that was created by another application.
/admin/api/unstable/orders/{order_id}/risks/{risk_id}.jsonDeletes an order risk for an order Note You cannot delete an order risk that was created by another application.
/admin/api/unstable/price_rules/{price_rule_id}/batch.jsonCreates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"
/admin/api/2020-01/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/2020-01/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/2020-01/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/2020-01/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/2020-04/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/2020-04/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/2020-04/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/2020-04/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/2020-07/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/2020-07/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/2020-07/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/2020-07/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/2020-10/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/2020-10/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/2020-10/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/2020-10/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/2021-01/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/2021-01/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/2021-01/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/2021-01/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/unstable/products/{product_id}/images/count.jsonGet a count of all product images
/admin/api/2020-01/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/2020-01/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/2020-01/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/2020-01/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/2020-01/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/2020-04/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/2020-04/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/2020-04/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/2020-04/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/2020-04/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/2020-07/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/2020-07/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/2020-07/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/2020-07/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/2020-07/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/2020-10/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/2020-10/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/2020-10/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/2020-10/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/2020-10/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/2021-01/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/2021-01/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/2021-01/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/2021-01/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/2021-01/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/unstable/customers/{customer_id}/send_invite.jsonSends an account invite to a customer.
/admin/api/unstable/inventory_items/{inventory_item_id}.jsonRetrieves a single inventory item by ID
/admin/api/unstable/inventory_items/{inventory_item_id}.jsonUpdates an existing inventory item
/admin/api/unstable/orders/{order_id}/refunds/calculate.jsonCaution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted.
/admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/2020-01/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/2020-01/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/2020-01/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/2020-01/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/2020-01/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/2020-01/product_listings/{product_listing_id}.jsonRetrieve a specific product listing that is published to your app
/admin/api/2020-01/product_listings/{product_listing_id}.jsonCreate a product listing to publish a product to your app
/admin/api/2020-01/product_listings/{product_listing_id}.jsonDelete a product listing to unpublish a product from your app
/admin/api/2020-01/shopify_payments/balance/transactions.jsonRetrieves a list of all balance transactions ordered by processing time, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/2020-04/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/2020-04/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/2020-04/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/2020-04/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/2020-04/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/2020-04/product_listings/{product_listing_id}.jsonRetrieve a specific product listing that is published to your app
/admin/api/2020-04/product_listings/{product_listing_id}.jsonCreate a product listing to publish a product to your app
/admin/api/2020-04/product_listings/{product_listing_id}.jsonDelete a product listing to unpublish a product from your app
/admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/2020-07/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/2020-07/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/2020-07/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/2020-07/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/2020-07/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/2020-07/product_listings/{product_listing_id}.jsonRetrieve a specific product listing that is published to your app
/admin/api/2020-07/product_listings/{product_listing_id}.jsonCreate a product listing to publish a product to your app
/admin/api/2020-07/product_listings/{product_listing_id}.jsonDelete a product listing to unpublish a product from your app
/admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/2020-10/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/2020-10/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/2020-10/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/2020-10/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/2020-10/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/2021-01/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/2021-01/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/2021-01/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/2021-01/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/2021-01/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/unstable/collections/{collection_id}/products.jsonRetrieve a list of products belonging to a collection. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.. The products returned are sorted by the collection's sort order.
/admin/api/unstable/fulfillments/{fulfillment_id}/cancel.jsonCancels a fulfillment.
/admin/api/unstable/orders/{order_id}/fulfillment_orders.jsonRetrieves a list of fulfillment orders for a specific order.
/admin/api/unstable/orders/{order_id}/fulfillments/count.jsonRetrieves a count of fulfillments associated with a specific order
/admin/api/unstable/shopify_payments/payouts/{payout_id}.jsonRetrieves a single payout by id.
/admin/api/2020-01/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/2020-01/shopify_payments/disputes/{dispute_id}.jsonRetrieves a single dispute by ID.
/admin/api/2020-04/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/2020-07/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/2020-10/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/2021-01/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/unstable/blogs/{blog_id}/articles/{article_id}.jsonRetrieves a single article
/admin/api/unstable/blogs/{blog_id}/articles/{article_id}.jsonUpdates an article
/admin/api/unstable/blogs/{blog_id}/articles/{article_id}.jsonDeletes an article
/admin/api/unstable/carrier_services/{carrier_service_id}.jsonRetrieves a single carrier service by its ID
/admin/api/unstable/carrier_services/{carrier_service_id}.jsonUpdates a carrier service. Only the app that creates a carrier service can update it.
/admin/api/unstable/carrier_services/{carrier_service_id}.jsonDeletes a carrier service
/admin/api/unstable/customers/{customer_id}/addresses/set.jsonPerforms bulk operations for multiple customer addresses.
/admin/api/unstable/orders/{order_id}/refunds/{refund_id}.jsonRetrieves a specific refund.
/admin/api/2020-01/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/2020-01/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/2020-01/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/2020-01/products/{product_id}/images/{image_id}.json/admin/api/2020-01/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/2020-01/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/2020-01/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/2020-04/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/2020-04/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/2020-04/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/2020-04/products/{product_id}/images/{image_id}.json/admin/api/2020-04/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/2020-04/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/2020-04/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/2020-07/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/2020-07/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/2020-07/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/2020-07/products/{product_id}/images/{image_id}.json/admin/api/2020-07/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/2020-07/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/2020-07/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/2020-10/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/2020-10/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/2020-10/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/2020-10/products/{product_id}/images/{image_id}.json/admin/api/2020-10/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/2020-10/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/2020-10/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/2021-01/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/2021-01/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/2021-01/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/2021-01/products/{product_id}/images/{image_id}.json/admin/api/2021-01/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/2021-01/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/2021-01/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/unstable/countries/{country_id}/provinces/count.jsonRetrieves a count of provinces for a country
/admin/api/2020-01/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/checkouts/{token}/payments/{payment_id}.jsonRetrieves the payment information for an existing payment
/admin/api/unstable/products/{product_id}/images/{image_id}.jsonGet a single product image by id
/admin/api/unstable/products/{product_id}/images/{image_id}.jsonModify an existing product image
/admin/api/unstable/products/{product_id}/images/{image_id}.json/admin/api/unstable/smart_collections/{smart_collection_id}.jsonRetrieves a single smart collection
/admin/api/unstable/smart_collections/{smart_collection_id}.jsonUpdates an existing smart collection
/admin/api/unstable/smart_collections/{smart_collection_id}.jsonRemoves a smart collection
/admin/api/2020-01/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/2020-01/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/2020-01/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/2020-04/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/2020-04/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/2020-04/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/2020-07/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/2020-07/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/2020-07/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/2020-10/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/2020-10/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/2020-10/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/2021-01/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/2021-01/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/2021-01/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/unstable/locations/{location_id}/inventory_levels.jsonRetrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/unstable/custom_collections/{custom_collection_id}.jsonRetrieves a single custom collection
/admin/api/unstable/custom_collections/{custom_collection_id}.jsonUpdates an existing custom collection
/admin/api/unstable/custom_collections/{custom_collection_id}.jsonDeletes a custom collection
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}.jsonRetrieves a specific fulfillment order.
/admin/api/2020-01/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/2020-01/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/2020-01/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/2020-01/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/2020-01/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/2020-04/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/2020-04/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/2020-04/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/2020-04/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/2020-04/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/2020-07/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/2020-07/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/2020-07/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/2020-07/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/2020-07/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/2020-10/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/2020-10/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/2020-10/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/2020-10/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/2020-10/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/2021-01/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/2021-01/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/2021-01/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/2021-01/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/2021-01/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/unstable/price_rules/{price_rule_id}/discount_codes.jsonRetrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/price_rules/{price_rule_id}/discount_codes.jsonCreates a discount code
/admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/unstable/application_charges/{application_charge_id}.jsonRetrieves an application charge
/admin/api/unstable/application_credits/{application_credit_id}.jsonRetrieves a single application credit
/admin/api/unstable/collection_listings/{collection_listing_id}.jsonRetrieve a specific collection listing that is published to your app
/admin/api/unstable/collection_listings/{collection_listing_id}.jsonCreate a collection listing to publish a collection to your app
/admin/api/unstable/collection_listings/{collection_listing_id}.jsonDelete a collection listing to unpublish a collection from your app
/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-01/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/2020-01/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-04/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/2020-04/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/2020-07/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-07/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-07/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-07/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/2020-07/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/2020-10/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-10/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-10/fulfillment_services/{fulfillment_service_id}.json/admin/api/2020-10/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/2020-10/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/2021-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2021-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2021-01/fulfillment_services/{fulfillment_service_id}.json/admin/api/2021-01/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/2021-01/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}.jsonRetrieves a discount code creation job
/admin/api/2020-01/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/2020-01/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/2020-01/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/2020-04/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/2020-04/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/2020-04/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/2020-07/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/2020-07/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/2020-07/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/2020-10/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/2020-10/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/2020-10/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/2021-01/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/2021-01/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/2021-01/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/open.jsonMarks a scheduled fulfillment order as ready for fulfillment. This endpoint allows merchants to work on a scheduled fulfillment order before its expected fulfill_at datetime.
/admin/api/unstable/fulfillment_services/{fulfillment_service_id}.json/admin/api/unstable/fulfillment_services/{fulfillment_service_id}.json/admin/api/unstable/fulfillment_services/{fulfillment_service_id}.json/admin/api/unstable/fulfillments/{fulfillment_id}/update_tracking.jsonUpdates the tracking information for a fulfillment.
/admin/api/unstable/smart_collections/{smart_collection_id}/order.jsonUpdates the ordering type of products in a smart collection
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/unstable/countries/{country_id}/provinces/{province_id}.jsonRetrieves a single province for a country
/admin/api/unstable/countries/{country_id}/provinces/{province_id}.jsonCaution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country.
/admin/api/unstable/customers/{customer_id}/account_activation_url.jsonGenerate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid.
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.jsonRetrieves details a single customer address.
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.jsonUpdates an existing customer address.
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.jsonRemoves an address from a customer’s address list.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/move.jsonMoves a fulfillment order from one merchant managed location to another merchant managed location.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/open.jsonMarks a scheduled fulfillment order as ready for fulfillment. This endpoint allows merchants to work on a scheduled fulfillment order before its expected fulfill_at datetime.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/close.jsonMarks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}.jsonRetrieve a specific fulfillment
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}.jsonUpdate information associated with a fulfillment
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancel.jsonMarks a fulfillment order as cancelled.
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.jsonRetrieves a single customer saved search.
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.jsonUpdates a customer saved search.
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.jsonDeletes a customer saved search.
/admin/api/2020-01/application_charges/{application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. "Activates an accepted application charge. One-time charges are now immediately activated when approved by a merchant.
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2020-04/application_charges/{application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. "Activates an accepted application charge. One-time charges are now immediately activated when approved by a merchant.
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2020-07/application_charges/{application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. "Activates an accepted application charge. One-time charges are now immediately activated when approved by a merchant.
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2020-10/application_charges/{application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. "Activates an accepted application charge. One-time charges are now immediately activated when approved by a merchant.
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/reschedule.jsonUpdates the fulfill_at time of a scheduled fulfillment order. This endpoint is used to manage the time a scheduled fulfillment order will be marked as ready for fulfillment.
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2020-01/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/2020-04/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/2020-07/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/2020-10/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/2021-01/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/reschedule.jsonUpdates the fulfill_at time of a scheduled fulfillment order. This endpoint is used to manage the time a scheduled fulfillment order will be marked as ready for fulfillment.
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/open.jsonMark a fulfillment as open
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/unstable/storefront_access_tokens/{storefront_access_token_id}.jsonDeletes an existing storefront access token
/admin/api/2020-01/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-04/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-07/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2020-10/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/2021-01/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}/default.jsonSets the default address for a customer.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillments.jsonRetrieves fulfillments associated with a fulfillment order.
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.jsonCancel a fulfillment for a specific order ID
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonRetrieves a list of fulfillment events for a specific fulfillment
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events.jsonCreates a fulfillment event
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/unstable/collection_listings/{collection_listing_id}/product_ids.jsonRetrieve product_ids that are published to a collection_id. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/complete.jsonMark a fulfillment as complete
/admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.jsonRetrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}/customers.jsonRetrieves all customers returned by a customer saved search.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/locations_for_move.jsonRetrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.jsonSends a fulfillment request to the fulfillment service of a fulfillment order.
/admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonRetrieves a single discount code
/admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonUpdates an existing discount code
/admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.jsonDeletes a discount code
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request.jsonSends a cancellation request to the fulfillment service of a fulfillment order.
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}.jsonRetrieves a single charge
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}.jsonCancels a recurring application charge
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonRetrieves a specific fulfillment event
/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.jsonDeletes a fulfillment event
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects a fulfillment request sent to a fulfillment service for a fulfillment order.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.jsonAccepts a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.jsonRejects a cancellation request sent to a fulfillment service for a fulfillment order.
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. Activates a previously accepted recurring application charge. Recurring charges are now immediately activated when approved by a merchant.
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. Activates a previously accepted recurring application charge. Recurring charges are now immediately activated when approved by a merchant.
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. Activates a previously accepted recurring application charge. Recurring charges are now immediately activated when approved by a merchant.
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/activate.jsonCaution This endpoint is no longer required and is deprecated as of API version 2021-01. Activates a previously accepted recurring application charge. Recurring charges are now immediately activated when approved by a merchant.
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/customize.jsonUpdates the capped amount of an active recurring application charge
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonRetrieves a list of usage charges
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges.jsonCreates a usage charge
/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge
/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.jsonRetrieves a single charge