naftiko: 1.0.0-alpha2 info: label: Shopify API — Retrieves description: 'Shopify API — Retrieves. 619 operations. Lead operation: Shopify Retrieves A List All Of Article Authors. Self-contained Naftiko capability covering one Shopify business surface.' tags: - Shopify - Retrieves created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: SHOPIFY_API_KEY: SHOPIFY_API_KEY capability: consumes: - type: http namespace: shopify-retrieves baseUri: '' description: Shopify API — Retrieves business capability. Self-contained, no shared references. resources: - name: admin-api-2020-01-articles-authors.json path: /admin/api/2020-01/articles/authors.json operations: - name: deprecated202001getarticlesauthors method: GET description: Shopify Retrieves A List All Of Article Authors outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-articles-tags.json path: /admin/api/2020-01/articles/tags.json operations: - name: deprecated202001getarticlestags method: GET description: Shopify Retrieves A List Of All The Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of tags to retrieve. - name: popular in: query type: string description: A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag. - name: admin-api-2020-01-assigned_fulfillment_orders.json path: /admin/api/2020-01/assigned_fulfillment_orders.json operations: - name: deprecated202001getassignedfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: assignment_status in: query type: string description: 'The assigment status of the fulfillment orders that should be returned:' - name: location_ids in: query type: string description: The IDs of the assigned locations of the fulfillment orders that should be returned. - name: location_ids[] in: query type: integer description: location_ids[] - name: admin-api-2020-01-blogs.json path: /admin/api/2020-01/blogs.json operations: - name: deprecated202001getblogs method: GET description: Shopify Retrieve A List Of All Blogs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Restrict results to after the specified ID - name: handle in: query type: string description: Filter by blog handle - name: fields in: query type: string description: comma-separated list of fields to include in the response - name: admin-api-2020-01-blogs-blog_id-articles.json path: /admin/api/2020-01/blogs/{blog_id}/articles.json operations: - name: deprecated202001getblogsparamblogidarticles method: GET description: Shopify Retrieves A List Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Retrieve results based on their published status. - name: handle in: query type: string description: Retrieve an article with a specific handle. - name: tag in: query type: string description: Filter articles with a specific tag. - name: author in: query type: string description: Filter articles by article author. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-blogs-blog_id-articles-count.json path: /admin/api/2020-01/blogs/{blog_id}/articles/count.json operations: - name: deprecated202001getblogsparamblogidarticlescount method: GET description: Shopify Retrieves A Count Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: created_at_min in: query type: string description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count articles with a given published status. - name: admin-api-2020-01-blogs-blog_id-articles-article_id}.json path: /admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.json operations: - name: deprecated202001getblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-2020-01-carrier_services.json path: /admin/api/2020-01/carrier_services.json operations: - name: deprecated202001getcarrierservices method: GET description: Shopify Retrieves A List Of Carrier Services outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-carrier_services-carrier_service_id}.json path: /admin/api/2020-01/carrier_services/{carrier_service_id}.json operations: - name: deprecated202001getcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-2020-01-checkouts-count.json path: /admin/api/2020-01/checkouts/count.json operations: - name: deprecated202001getcheckoutscount method: GET description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: status in: query type: string description: Count checkouts with a given status. - name: admin-api-2020-01-checkouts-token}.json path: /admin/api/2020-01/checkouts/{token}.json operations: - name: deprecated202001getcheckoutsparamtoken method: GET description: Shopify Retrieves A Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-01-checkouts-token-payments.json path: /admin/api/2020-01/checkouts/{token}/payments.json operations: - name: deprecated202001getcheckoutsparamtokenpayments method: GET description: Shopify Retrieves A List Of Payments On A Particular Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-01-checkouts-token-payments-payment_id}.json path: /admin/api/2020-01/checkouts/{token}/payments/{payment_id}.json operations: - name: deprecated202001getcheckoutsparamtokenpaymentsparampaymentid method: GET description: Shopify Retrieves The Payment Information For An Existing Payment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: payment_id in: path type: string description: payment_id required: true - name: admin-api-2020-01-checkouts-token-shipping_rates.json path: /admin/api/2020-01/checkouts/{token}/shipping_rates.json operations: - name: deprecated202001getcheckoutsparamtokenshippingrates method: GET description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-01-collection_listings.json path: /admin/api/2020-01/collection_listings.json operations: - name: deprecated202001getcollectionlistings method: GET description: Shopify Retrieve Collection Listings That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: Amount of results - name: admin-api-2020-01-collection_listings-collection_listing_id}.json path: /admin/api/2020-01/collection_listings/{collection_listing_id}.json operations: - name: deprecated202001getcollectionlistingsparamcollectionlistingid method: GET description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: admin-api-2020-01-collection_listings-collection_listing_id-product_ids.json path: /admin/api/2020-01/collection_listings/{collection_listing_id}/product_ids.json operations: - name: deprecated202001getcollectionlistingsparamcollectionlistingidproductids method: GET description: Shopify Retrieve Product_ids That Are Published To A Collection_id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: limit in: query type: string description: Amount of results - name: admin-api-2020-01-collections-collection_id}.json path: /admin/api/2020-01/collections/{collection_id}.json operations: - name: deprecated202001getcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-collections-collection_id-products.json path: /admin/api/2020-01/collections/{collection_id}/products.json operations: - name: deprecated202001getcollectionsparamcollectionidproducts method: GET description: Shopify Retrieve A List Of Products Belonging To A Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: limit in: query type: string description: The number of products to retrieve. - name: admin-api-2020-01-collects.json path: /admin/api/2020-01/collects.json operations: - name: deprecated202001getcollects method: GET description: Shopify Retrieves A List Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-collects-count.json path: /admin/api/2020-01/collects/count.json operations: - name: deprecated202001getcollectscount method: GET description: Shopify Retrieves A Count Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: query type: integer description: collection_id - name: admin-api-2020-01-collects-collect_id}.json path: /admin/api/2020-01/collects/{collect_id}.json operations: - name: deprecated202001getcollectsparamcollectid method: GET description: Shopify Retrieves A Specific Collect By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collect_id in: path type: string description: collect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-comments.json path: /admin/api/2020-01/comments.json operations: - name: deprecated202001getcomments method: GET description: Shopify Retrieves A List Of Comments outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show comments created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Show comments created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show comments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show comments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show comments published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show comments published before date (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: published_status in: query type: string description: Filter results by their published status. - name: status in: query type: string description: Filter results by their status. - name: article_id in: query type: integer description: article_id - name: blog_id in: query type: integer description: blog_id - name: admin-api-2020-01-comments-count.json path: /admin/api/2020-01/comments/count.json operations: - name: deprecated202001getcommentscount method: GET description: Shopify Retrieves A Count Of Comments outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created_at_min in: query type: string description: 'Count comments created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count comments created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count comments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count comments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count comments published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count comments published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Retrieve a count of comments with a given published status. - name: status in: query type: string description: Retrieve a count of comments with a given status. - name: article_id in: query type: integer description: article_id - name: blog_id in: query type: integer description: blog_id - name: admin-api-2020-01-comments-comment_id}.json path: /admin/api/2020-01/comments/{comment_id}.json operations: - name: deprecated202001getcommentsparamcommentid method: GET description: Shopify Retrieves A Single Comment By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: comment_id in: path type: string description: comment_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-countries.json path: /admin/api/2020-01/countries.json operations: - name: deprecated202001getcountries method: GET description: Shopify Retrieves A List Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-countries-count.json path: /admin/api/2020-01/countries/count.json operations: - name: deprecated202001getcountriescount method: GET description: Shopify Retrieves A Count Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-countries-country_id}.json path: /admin/api/2020-01/countries/{country_id}.json operations: - name: deprecated202001getcountriesparamcountryid method: GET description: Shopify Retrieves A Specific County outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-countries-country_id-provinces.json path: /admin/api/2020-01/countries/{country_id}/provinces.json operations: - name: deprecated202001getcountriesparamcountryidprovinces method: GET description: Shopify Retrieves A List Of Provinces outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of fields names. - name: admin-api-2020-01-countries-country_id-provinces-count.json path: /admin/api/2020-01/countries/{country_id}/provinces/count.json operations: - name: deprecated202001getcountriesparamcountryidprovincescount method: GET description: Shopify Retrieves A Count Of Provinces For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: admin-api-2020-01-countries-country_id-provinces-province_id}.json path: /admin/api/2020-01/countries/{country_id}/provinces/{province_id}.json operations: - name: deprecated202001getcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-currencies.json path: /admin/api/2020-01/currencies.json operations: - name: deprecated202001getcurrencies method: GET description: Shopify Retrieves A List Of Currencies Enabled On A Shop outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-custom_collections.json path: /admin/api/2020-01/custom_collections.json operations: - name: deprecated202001getcustomcollections method: GET description: Shopify Retrieves A List Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: ids in: query type: string description: Show only collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show custom collections with a given title. - name: product_id in: query type: string description: Show custom collections that include a given product. - name: handle in: query type: string description: Filter by custom collection handle. - name: updated_at_min in: query type: string description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Show custom collectsion with a given published status. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-custom_collections-count.json path: /admin/api/2020-01/custom_collections/count.json operations: - name: deprecated202001getcustomcollectionscount method: GET description: Shopify Retrieves A Count Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Count custom collections with given title. - name: product_id in: query type: string description: Count custom collections that include a given product. - name: updated_at_min in: query type: string description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count custom collections with a given published status. - name: admin-api-2020-01-custom_collections-custom_collection_id}.json path: /admin/api/2020-01/custom_collections/{custom_collection_id}.json operations: - name: deprecated202001getcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-customer_saved_searches.json path: /admin/api/2020-01/customer_saved_searches.json operations: - name: deprecated202001getcustomersavedsearches method: GET description: Shopify Retrieves A List Of Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-customer_saved_searches-count.json path: /admin/api/2020-01/customer_saved_searches/count.json operations: - name: deprecated202001getcustomersavedsearchescount method: GET description: Shopify Retrieves A Count Of All Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID - name: admin-api-2020-01-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json operations: - name: deprecated202001getcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-customer_saved_searches-customer_saved_search_id-customers.jso path: /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}/customers.json operations: - name: deprecated202001getcustomersavedsearchesparamcustomersavedsearchidcustomers method: GET description: Shopify Retrieves All Customers Returned By A Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: order in: query type: string description: Set the field and direction by which to order results. - name: limit in: query type: string description: The maximum number of results to show. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-customers-customer_id-addresses.json path: /admin/api/2020-01/customers/{customer_id}/addresses.json operations: - name: deprecated202001getcustomersparamcustomeridaddresses method: GET description: Shopify Retrieves A List Of Addresses For A Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: admin-api-2020-01-customers-customer_id-addresses-address_id}.json path: /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json operations: - name: deprecated202001getcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-2020-01-discount_codes-lookup.json path: /admin/api/2020-01/discount_codes/lookup.json operations: - name: deprecated202001getdiscountcodeslookup method: GET description: Shopify Retrieves The Location Of A Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: code in: query type: integer description: code - name: admin-api-2020-01-events.json path: /admin/api/2020-01/events.json operations: - name: deprecated202001getevents method: GET description: Shopify Retrieves A List Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: since_id in: query type: string description: Show only results after the specified ID. - name: created_at_min in: query type: string description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: filter in: query type: string description: Show events specified in this filter. - name: verb in: query type: string description: Show events of a certain type. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-events-count.json path: /admin/api/2020-01/events/count.json operations: - name: deprecated202001geteventscount method: GET description: Shopify Retrieves A Count Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created_at_min in: query type: string description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: admin-api-2020-01-events-event_id}.json path: /admin/api/2020-01/events/{event_id}.json operations: - name: deprecated202001geteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-fulfillment_orders-fulfillment_order_id}.json path: /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}.json operations: - name: deprecated202001getfulfillmentordersparamfulfillmentorderid method: GET description: Shopify Retrieves A Specific Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: admin-api-2020-01-fulfillment_orders-fulfillment_order_id-fulfillments.json path: /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json operations: - name: deprecated202001getfulfillmentordersparamfulfillmentorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order that is associated with the fulfillments. - name: admin-api-2020-01-fulfillment_orders-fulfillment_order_id-locations_for_move.jso path: /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json operations: - name: deprecated202001getfulfillmentordersparamfulfillmentorderidlocationsformove method: GET description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order. - name: admin-api-2020-01-gift_cards.json path: /admin/api/2020-01/gift_cards.json operations: - name: deprecated202001getgiftcards method: GET description: Shopify Retrieves A List Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Retrieve gift cards with a given status. Valid values:' - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-gift_cards-count.json path: /admin/api/2020-01/gift_cards/count.json operations: - name: deprecated202001getgiftcardscount method: GET description: Shopify Retrieves A Count Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Count gift cards with a given status. Valid values:' - name: admin-api-2020-01-gift_cards-gift_card_id}.json path: /admin/api/2020-01/gift_cards/{gift_card_id}.json operations: - name: deprecated202001getgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-2020-01-inventory_items.json path: /admin/api/2020-01/inventory_items.json operations: - name: deprecated202001getinventoryitems method: GET description: Shopify Retrieves A List Of Inventory Items outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "ids\n required" in: query type: string description: Show only inventory items specified by a comma-separated list of IDs. - name: limit in: query type: string description: The maximum number of results to show. - name: ids in: query type: integer description: ids - name: admin-api-2020-01-inventory_items-inventory_item_id}.json path: /admin/api/2020-01/inventory_items/{inventory_item_id}.json operations: - name: deprecated202001getinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-2020-01-inventory_levels.json path: /admin/api/2020-01/inventory_levels.json operations: - name: deprecated202001getinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_ids in: query type: string description: A comma-separated list of inventory item IDs. - name: location_ids in: query type: string description: A comma-separated list of location IDs. To find the ID of a location, use the Location resource. - name: limit in: query type: string description: The maximum number of results to show. - name: updated_at_min in: query type: string description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' - name: admin-api-2020-01-locations.json path: /admin/api/2020-01/locations.json operations: - name: deprecated202001getlocations method: GET description: Shopify Retrieves A List Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-locations-count.json path: /admin/api/2020-01/locations/count.json operations: - name: deprecated202001getlocationscount method: GET description: Shopify Retrieves A Count Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-locations-location_id}.json path: /admin/api/2020-01/locations/{location_id}.json operations: - name: deprecated202001getlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-01-locations-location_id-inventory_levels.json path: /admin/api/2020-01/locations/{location_id}/inventory_levels.json operations: - name: deprecated202001getlocationsparamlocationidinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels For A Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-01-metafields.json path: /admin/api/2020-01/metafields.json operations: - name: deprecated202001getmetafields method: GET description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield[owner_id] in: query type: integer description: metafield[owner_id] - name: metafield[owner_resource] in: query type: string description: metafield[owner_resource] - name: admin-api-2020-01-metafields-count.json path: /admin/api/2020-01/metafields/count.json operations: - name: deprecated202001getmetafieldscount method: GET description: Shopify Retrieves A Count Of A Resource's Metafields outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-metafields-metafield_id}.json path: /admin/api/2020-01/metafields/{metafield_id}.json operations: - name: deprecated202001getmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-orders.json path: /admin/api/2020-01/orders.json operations: - name: deprecated202001getorders method: GET description: Shopify Retrieves A List Of Orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Retrieve only orders specified by a comma-separated list of order IDs. - name: limit in: query type: string description: The maximum number of results to show on a page. - name: since_id in: query type: string description: Show orders after the specified ID. - name: created_at_min in: query type: string description: 'Show orders created at or after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00).' - name: processed_at_min in: query type: string description: 'Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00).' - name: processed_at_max in: query type: string description: 'Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00).' - name: attribution_app_id in: query type: string description: Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for the app currently consuming the API. - name: status in: query type: string description: Filter orders by their status. - name: financial_status in: query type: string description: Filter orders by their financial status. - name: fulfillment_status in: query type: string description: Filter orders by their fulfillment status. - name: fields in: query type: string description: Retrieve only certain fields, specified by a comma-separated list of fields names. - name: admin-api-2020-01-orders-count.json path: /admin/api/2020-01/orders/count.json operations: - name: deprecated202001getorderscount method: GET description: Shopify Retrieves An Order Count outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created_at_min in: query type: string description: 'Count orders created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count orders created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count orders last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count orders last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: status in: query type: string description: Count orders of a given status. - name: financial_status in: query type: string description: Count orders of a given financial status. - name: fulfillment_status in: query type: string description: Filter orders by their fulfillment status. - name: admin-api-2020-01-orders-order_id}.json path: /admin/api/2020-01/orders/{order_id}.json operations: - name: deprecated202001getordersparamorderid method: GET description: Shopify Retrieves A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fields in: query type: string description: Retrieve only certain fields, specified by a comma-separated list of fields names. - name: admin-api-2020-01-orders-order_id-fulfillment_orders.json path: /admin/api/2020-01/orders/{order_id}/fulfillment_orders.json operations: - name: deprecated202001getordersparamorderidfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: order_id in: query type: string description: The ID of the order that is associated with the fulfillment orders. - name: admin-api-2020-01-orders-order_id-fulfillments.json path: /admin/api/2020-01/orders/{order_id}/fulfillments.json operations: - name: deprecated202001getordersparamorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_max in: query type: string description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: limit in: query type: string description: Limit the amount of results. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_max in: query type: string description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-01-orders-order_id-fulfillments-count.json path: /admin/api/2020-01/orders/{order_id}/fulfillments/count.json operations: - name: deprecated202001getordersparamorderidfulfillmentscount method: GET description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_min in: query type: string description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-01-orders-order_id-fulfillments-fulfillment_id}.json path: /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.json operations: - name: deprecated202001getordersparamorderidfulfillmentsparamfulfillmentid method: GET description: Shopify Retrieve A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fields in: query type: string description: Comma-separated list of fields to include in the response. - name: admin-api-2020-01-orders-order_id-fulfillments-fulfillment_id-events.json path: /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json operations: - name: deprecated202001getordersparamorderidfulfillmentsparamfulfillmentidevents method: GET description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fulfillment_id in: query type: string description: The ID of the fulfillment that's associated with the fulfillment event. - name: order_id in: query type: string description: The ID of the order that's associated with the fulfillment event. - name: admin-api-2020-01-orders-order_id-fulfillments-fulfillment_id-events-event_id}.j path: /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json operations: - name: deprecated202001getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid method: GET description: Shopify Retrieves A Specific Fulfillment Event outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: event_id in: path type: string description: event_id required: true - name: event_id in: query type: string description: The ID of the fulfillment event. - name: admin-api-2020-01-orders-order_id-refunds.json path: /admin/api/2020-01/orders/{order_id}/refunds.json operations: - name: deprecated202001getordersparamorderidrefunds method: GET description: Shopify Retrieves A List Of Refunds For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-2020-01-orders-order_id-refunds-refund_id}.json path: /admin/api/2020-01/orders/{order_id}/refunds/{refund_id}.json operations: - name: deprecated202001getordersparamorderidrefundsparamrefundid method: GET description: Shopify Retrieves A Specific Refund outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: refund_id in: path type: string description: refund_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-2020-01-orders-order_id-risks.json path: /admin/api/2020-01/orders/{order_id}/risks.json operations: - name: deprecated202001getordersparamorderidrisks method: GET description: Shopify Retrieves A List Of All Order Risks For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: admin-api-2020-01-orders-order_id-risks-risk_id}.json path: /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json operations: - name: deprecated202001getordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-2020-01-policies.json path: /admin/api/2020-01/policies.json operations: - name: deprecated202001getpolicies method: GET description: Shopify Retrieves A List Of The Shop's Policies outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-price_rules-price_rule_id-batch-batch_id}.json path: /admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}.json operations: - name: deprecated202001getpricerulesparampriceruleidbatchparambatchid method: GET description: Shopify Retrieves A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-2020-01-price_rules-price_rule_id-batch-batch_id-discount_codes.json path: /admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json operations: - name: deprecated202001getpricerulesparampriceruleidbatchparambatchiddiscountcodes method: GET description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-2020-01-price_rules-price_rule_id-discount_codes.json path: /admin/api/2020-01/price_rules/{price_rule_id}/discount_codes.json operations: - name: deprecated202001getpricerulesparampriceruleiddiscountcodes method: GET description: Shopify Retrieve A List Of Discount Codes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: admin-api-2020-01-price_rules-price_rule_id-discount_codes-discount_code_id}.jso path: /admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: deprecated202001getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-2020-01-product_listings.json path: /admin/api/2020-01/product_listings.json operations: - name: deprecated202001getproductlistings method: GET description: Shopify Retrieve Product Listings That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_ids in: query type: string description: A comma-separated list of product ids - name: limit in: query type: string description: Amount of results - name: collection_id in: query type: string description: Filter by products belonging to a particular collection - name: updated_at_min in: query type: string description: Filter by products last updated after a certain date and time (formatted in ISO 8601) - name: handle in: query type: string description: Filter by product handle - name: admin-api-2020-01-product_listings-count.json path: /admin/api/2020-01/product_listings/count.json operations: - name: deprecated202001getproductlistingscount method: GET description: Shopify Retrieve A Count Of Products That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-product_listings-product_ids.json path: /admin/api/2020-01/product_listings/product_ids.json operations: - name: deprecated202001getproductlistingsproductids method: GET description: Shopify Retrieve Product_ids That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: Amount of results - name: admin-api-2020-01-product_listings-product_listing_id}.json path: /admin/api/2020-01/product_listings/{product_listing_id}.json operations: - name: deprecated202001getproductlistingsparamproductlistingid method: GET description: Shopify Retrieve A Specific Product Listing That Is Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_listing_id in: path type: string description: product_listing_id required: true - name: admin-api-2020-01-products.json path: /admin/api/2020-01/products.json operations: - name: deprecated202001getproducts method: GET description: Shopify Retrieves A List Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Return only products specified by a comma-separated list of product IDs. - name: limit in: query type: string description: Return up to this many results per page. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Filter results by product title. - name: vendor in: query type: string description: Filter results by product vendor. - name: handle in: query type: string description: Filter results by product handle. - name: product_type in: query type: string description: Filter results by product type. - name: status in: query type: string description: Return products by their status. - name: collection_id in: query type: string description: Filter results by product collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: presentment_currencies in: query type: string description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. - name: admin-api-2020-01-products-count.json path: /admin/api/2020-01/products/count.json operations: - name: deprecated202001getproductscount method: GET description: Shopify Retrieves A Count Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: vendor in: query type: string description: Filter results by product vendor. - name: product_type in: query type: string description: Filter results by product type. - name: collection_id in: query type: string description: Filter results by collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: admin-api-2020-01-products-product_id}.json path: /admin/api/2020-01/products/{product_id}.json operations: - name: deprecated202001getproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-01-redirects.json path: /admin/api/2020-01/redirects.json operations: - name: deprecated202001getredirects method: GET description: Shopify Retrieves A List Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: path in: query type: string description: Show redirects with a given path. - name: target in: query type: string description: Show redirects with a given target. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-redirects-count.json path: /admin/api/2020-01/redirects/count.json operations: - name: deprecated202001getredirectscount method: GET description: Shopify Retrieves A Count Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: path in: query type: string description: Count redirects with given path. - name: target in: query type: string description: Count redirects with given target. - name: admin-api-2020-01-redirects-redirect_id}.json path: /admin/api/2020-01/redirects/{redirect_id}.json operations: - name: deprecated202001getredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-script_tags.json path: /admin/api/2020-01/script_tags.json operations: - name: deprecated202001getscripttags method: GET description: Shopify Retrieves A List Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: src in: query type: string description: Show script tags with this URL. - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-01-script_tags-count.json path: /admin/api/2020-01/script_tags/count.json operations: - name: deprecated202001getscripttagscount method: GET description: Shopify Retrieves A Count Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: src in: query type: string description: Count only script tags with a given URL. - name: admin-api-2020-01-script_tags-script_tag_id}.json path: /admin/api/2020-01/script_tags/{script_tag_id}.json operations: - name: deprecated202001getscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-01-shop.json path: /admin/api/2020-01/shop.json operations: - name: deprecated202001getshop method: GET description: Shopify Retrieves The Shop's Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-01-shopify_payments-balance.json path: /admin/api/2020-01/shopify_payments/balance.json operations: - name: deprecated202001getshopifypaymentsbalance method: GET description: Shopify Retrieves The Account's Current Balance outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-shopify_payments-balance-transactions.json path: /admin/api/2020-01/shopify_payments/balance/transactions.json operations: - name: deprecated202001getshopifypaymentsbalancetransactions method: GET description: Shopify Retrieves A List Of All Balance Transactions Ordered By Processingtime outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Filter response to transactions exclusively after the specified ID. - name: last_id in: query type: string description: Filter response to transactions exclusively before the specified ID - name: test in: query type: string description: Filter response to transactions placed in test mode. - name: payout_id in: query type: string description: Filter response to transactions paid out in the specified payout. - name: payout_status in: query type: string description: Filter response to transactions with the specified payout status - name: admin-api-2020-01-shopify_payments-disputes.json path: /admin/api/2020-01/shopify_payments/disputes.json operations: - name: deprecated202001getshopifypaymentsdisputes method: GET description: Shopify Retrieve All Disputes Ordered By Initiated_at Date And Time (iso 8601 Format) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Return only disputes after the specified ID. - name: last_id in: query type: string description: Return only disputes before the specified ID. - name: status in: query type: string description: Return only disputes with the specified status. - name: initiated_at in: query type: string description: Return only disputes with the specified initiated_at date (ISO 8601 format). - name: admin-api-2020-01-shopify_payments-disputes-dispute_id}.json path: /admin/api/2020-01/shopify_payments/disputes/{dispute_id}.json operations: - name: deprecated202001getshopifypaymentsdisputesparamdisputeid method: GET description: Shopify Retrieves A Single Dispute By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: dispute_id in: path type: string description: dispute_id required: true - name: admin-api-2020-01-shopify_payments-payouts.json path: /admin/api/2020-01/shopify_payments/payouts.json operations: - name: deprecated202001getshopifypaymentspayouts method: GET description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Filter the response to payouts made after the specified ID. - name: last_id in: query type: string description: Filter the response to payouts made before the specified ID. - name: date_min in: query type: string description: Filter the response to payouts made inclusively after the specified date. - name: date_max in: query type: string description: Filter the response to payouts made inclusively before the specified date. - name: date in: query type: string description: Filter the response to payouts made on the specified date. - name: status in: query type: string description: Filter the response to payouts made with the specified status. - name: admin-api-2020-01-shopify_payments-payouts-payout_id}.json path: /admin/api/2020-01/shopify_payments/payouts/{payout_id}.json operations: - name: deprecated202001getshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-2020-01-smart_collections.json path: /admin/api/2020-01/smart_collections.json operations: - name: deprecated202001getsmartcollections method: GET description: Shopify Retrieves A List Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: ids in: query type: string description: Show only the smart collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that includes the specified product. - name: handle in: query type: string description: Filter results by smart collection handle. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-smart_collections-count.json path: /admin/api/2020-01/smart_collections/count.json operations: - name: deprecated202001getsmartcollectionscount method: GET description: Shopify Retrieves A Count Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that include the specified product. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: admin-api-2020-01-smart_collections-smart_collection_id}.json path: /admin/api/2020-01/smart_collections/{smart_collection_id}.json operations: - name: deprecated202001getsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-tender_transactions.json path: /admin/api/2020-01/tender_transactions.json operations: - name: deprecated202001gettendertransactions method: GET description: Shopify Retrieves A List Of Tender Transactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Retrieve only transactions after the specified ID. - name: processed_at_min in: query type: string description: Show tender transactions processed_at or after the specified date. - name: processed_at_max in: query type: string description: Show tender transactions processed_at or before the specified date. - name: processed_at in: query type: string description: Show tender transactions processed at the specified date. - name: order in: query type: string description: Show tender transactions ordered by processed_at in ascending or descending order. - name: admin-api-2020-01-themes.json path: /admin/api/2020-01/themes.json operations: - name: deprecated202001getthemes method: GET description: Shopify Retrieves A List Of Themes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-themes-theme_id}.json path: /admin/api/2020-01/themes/{theme_id}.json operations: - name: deprecated202001getthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-themes-theme_id-assets.json path: /admin/api/2020-01/themes/{theme_id}/assets.json operations: - name: deprecated202001getthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-2020-01-users.json path: /admin/api/2020-01/users.json operations: - name: deprecated202001getusers method: GET description: Shopify Retrieves A List Of All Users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show on a page. - name: page_info in: query type: string description: A unique ID used to access a certain page of results. - name: admin-api-2020-01-users-current.json path: /admin/api/2020-01/users/current.json operations: - name: deprecated202001getuserscurrent method: GET description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-01-users-user_id}.json path: /admin/api/2020-01/users/{user_id}.json operations: - name: deprecated202001getusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-2020-01-webhooks.json path: /admin/api/2020-01/webhooks.json operations: - name: deprecated202001getwebhooks method: GET description: Shopify Retrieves A List Of Webhooks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: created_at_max in: query type: string description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: limit in: query type: string description: Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error. - name: since_id in: query type: string description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: updated_at_min in: query type: string description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-01-webhooks-count.json path: /admin/api/2020-01/webhooks/count.json operations: - name: deprecated202001getwebhookscount method: GET description: Shopify Retrieves A Count Of Existing Webhook Subscriptions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: admin-api-2020-01-webhooks-webhook_id}.json path: /admin/api/2020-01/webhooks/{webhook_id}.json operations: - name: deprecated202001getwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: admin-api-2020-04-articles-authors.json path: /admin/api/2020-04/articles/authors.json operations: - name: deprecated202004getarticlesauthors method: GET description: Shopify Retrieves A List All Of Article Authors outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-articles-tags.json path: /admin/api/2020-04/articles/tags.json operations: - name: deprecated202004getarticlestags method: GET description: Shopify Retrieves A List Of All The Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of tags to retrieve. - name: popular in: query type: string description: A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag. - name: admin-api-2020-04-assigned_fulfillment_orders.json path: /admin/api/2020-04/assigned_fulfillment_orders.json operations: - name: deprecated202004getassignedfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: assignment_status in: query type: string description: 'The assigment status of the fulfillment orders that should be returned:' - name: location_ids in: query type: string description: The IDs of the assigned locations of the fulfillment orders that should be returned. - name: location_ids[] in: query type: integer description: location_ids[] - name: admin-api-2020-04-blogs-blog_id-articles.json path: /admin/api/2020-04/blogs/{blog_id}/articles.json operations: - name: deprecated202004getblogsparamblogidarticles method: GET description: Shopify Retrieves A List Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Retrieve results based on their published status. - name: handle in: query type: string description: Retrieve an article with a specific handle. - name: tag in: query type: string description: Filter articles with a specific tag. - name: author in: query type: string description: Filter articles by article author. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-blogs-blog_id-articles-count.json path: /admin/api/2020-04/blogs/{blog_id}/articles/count.json operations: - name: deprecated202004getblogsparamblogidarticlescount method: GET description: Shopify Retrieves A Count Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: created_at_min in: query type: string description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count articles with a given published status. - name: admin-api-2020-04-blogs-blog_id-articles-article_id}.json path: /admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.json operations: - name: deprecated202004getblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-2020-04-carrier_services.json path: /admin/api/2020-04/carrier_services.json operations: - name: deprecated202004getcarrierservices method: GET description: Shopify Retrieves A List Of Carrier Services outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-carrier_services-carrier_service_id}.json path: /admin/api/2020-04/carrier_services/{carrier_service_id}.json operations: - name: deprecated202004getcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-2020-04-checkouts-count.json path: /admin/api/2020-04/checkouts/count.json operations: - name: deprecated202004getcheckoutscount method: GET description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: status in: query type: string description: Count checkouts with a given status. - name: admin-api-2020-04-checkouts-token}.json path: /admin/api/2020-04/checkouts/{token}.json operations: - name: deprecated202004getcheckoutsparamtoken method: GET description: Shopify Retrieves A Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-04-checkouts-token-payments.json path: /admin/api/2020-04/checkouts/{token}/payments.json operations: - name: deprecated202004getcheckoutsparamtokenpayments method: GET description: Shopify Retrieves A List Of Payments On A Particular Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-04-checkouts-token-payments-payment_id}.json path: /admin/api/2020-04/checkouts/{token}/payments/{payment_id}.json operations: - name: deprecated202004getcheckoutsparamtokenpaymentsparampaymentid method: GET description: Shopify Retrieves The Payment Information For An Existing Payment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: payment_id in: path type: string description: payment_id required: true - name: admin-api-2020-04-checkouts-token-shipping_rates.json path: /admin/api/2020-04/checkouts/{token}/shipping_rates.json operations: - name: deprecated202004getcheckoutsparamtokenshippingrates method: GET description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-04-collection_listings.json path: /admin/api/2020-04/collection_listings.json operations: - name: deprecated202004getcollectionlistings method: GET description: Shopify Retrieve Collection Listings That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: Amount of results - name: admin-api-2020-04-collection_listings-collection_listing_id}.json path: /admin/api/2020-04/collection_listings/{collection_listing_id}.json operations: - name: deprecated202004getcollectionlistingsparamcollectionlistingid method: GET description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: admin-api-2020-04-collection_listings-collection_listing_id-product_ids.json path: /admin/api/2020-04/collection_listings/{collection_listing_id}/product_ids.json operations: - name: deprecated202004getcollectionlistingsparamcollectionlistingidproductids method: GET description: Shopify Retrieve Product_ids That Are Published To A Collection_id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: limit in: query type: string description: Amount of results - name: admin-api-2020-04-collections-collection_id}.json path: /admin/api/2020-04/collections/{collection_id}.json operations: - name: deprecated202004getcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-collections-collection_id-products.json path: /admin/api/2020-04/collections/{collection_id}/products.json operations: - name: deprecated202004getcollectionsparamcollectionidproducts method: GET description: Shopify Retrieve A List Of Products Belonging To A Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: limit in: query type: string description: The number of products to retrieve. - name: admin-api-2020-04-collects.json path: /admin/api/2020-04/collects.json operations: - name: deprecated202004getcollects method: GET description: Shopify Retrieves A List Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-collects-count.json path: /admin/api/2020-04/collects/count.json operations: - name: deprecated202004getcollectscount method: GET description: Shopify Retrieves A Count Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: query type: integer description: collection_id - name: admin-api-2020-04-collects-collect_id}.json path: /admin/api/2020-04/collects/{collect_id}.json operations: - name: deprecated202004getcollectsparamcollectid method: GET description: Shopify Retrieves A Specific Collect By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collect_id in: path type: string description: collect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-countries.json path: /admin/api/2020-04/countries.json operations: - name: deprecated202004getcountries method: GET description: Shopify Retrieves A List Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-countries-count.json path: /admin/api/2020-04/countries/count.json operations: - name: deprecated202004getcountriescount method: GET description: Shopify Retrieves A Count Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-countries-country_id}.json path: /admin/api/2020-04/countries/{country_id}.json operations: - name: deprecated202004getcountriesparamcountryid method: GET description: Shopify Retrieves A Specific County outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-countries-country_id-provinces.json path: /admin/api/2020-04/countries/{country_id}/provinces.json operations: - name: deprecated202004getcountriesparamcountryidprovinces method: GET description: Shopify Retrieves A List Of Provinces outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of fields names. - name: admin-api-2020-04-countries-country_id-provinces-count.json path: /admin/api/2020-04/countries/{country_id}/provinces/count.json operations: - name: deprecated202004getcountriesparamcountryidprovincescount method: GET description: Shopify Retrieves A Count Of Provinces For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: admin-api-2020-04-countries-country_id-provinces-province_id}.json path: /admin/api/2020-04/countries/{country_id}/provinces/{province_id}.json operations: - name: deprecated202004getcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-currencies.json path: /admin/api/2020-04/currencies.json operations: - name: deprecated202004getcurrencies method: GET description: Shopify Retrieves A List Of Currencies Enabled On A Shop outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-custom_collections.json path: /admin/api/2020-04/custom_collections.json operations: - name: deprecated202004getcustomcollections method: GET description: Shopify Retrieves A List Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: ids in: query type: string description: Show only collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show custom collections with a given title. - name: product_id in: query type: string description: Show custom collections that include a given product. - name: handle in: query type: string description: Filter by custom collection handle. - name: updated_at_min in: query type: string description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Show custom collectsion with a given published status. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-custom_collections-count.json path: /admin/api/2020-04/custom_collections/count.json operations: - name: deprecated202004getcustomcollectionscount method: GET description: Shopify Retrieves A Count Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Count custom collections with given title. - name: product_id in: query type: string description: Count custom collections that include a given product. - name: updated_at_min in: query type: string description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count custom collections with a given published status. - name: admin-api-2020-04-custom_collections-custom_collection_id}.json path: /admin/api/2020-04/custom_collections/{custom_collection_id}.json operations: - name: deprecated202004getcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-customer_saved_searches.json path: /admin/api/2020-04/customer_saved_searches.json operations: - name: deprecated202004getcustomersavedsearches method: GET description: Shopify Retrieves A List Of Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-customer_saved_searches-count.json path: /admin/api/2020-04/customer_saved_searches/count.json operations: - name: deprecated202004getcustomersavedsearchescount method: GET description: Shopify Retrieves A Count Of All Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID - name: admin-api-2020-04-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json operations: - name: deprecated202004getcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-customer_saved_searches-customer_saved_search_id-customers.jso path: /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}/customers.json operations: - name: deprecated202004getcustomersavedsearchesparamcustomersavedsearchidcustomers method: GET description: Shopify Retrieves All Customers Returned By A Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: order in: query type: string description: Set the field and direction by which to order results. - name: limit in: query type: string description: The maximum number of results to show. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-customers-customer_id-addresses.json path: /admin/api/2020-04/customers/{customer_id}/addresses.json operations: - name: deprecated202004getcustomersparamcustomeridaddresses method: GET description: Shopify Retrieves A List Of Addresses For A Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: admin-api-2020-04-customers-customer_id-addresses-address_id}.json path: /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json operations: - name: deprecated202004getcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-2020-04-discount_codes-lookup.json path: /admin/api/2020-04/discount_codes/lookup.json operations: - name: deprecated202004getdiscountcodeslookup method: GET description: Shopify Retrieves The Location Of A Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: code in: query type: integer description: code - name: admin-api-2020-04-events.json path: /admin/api/2020-04/events.json operations: - name: deprecated202004getevents method: GET description: Shopify Retrieves A List Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: since_id in: query type: string description: Show only results after the specified ID. - name: created_at_min in: query type: string description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: filter in: query type: string description: Show events specified in this filter. - name: verb in: query type: string description: Show events of a certain type. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-events-count.json path: /admin/api/2020-04/events/count.json operations: - name: deprecated202004geteventscount method: GET description: Shopify Retrieves A Count Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created_at_min in: query type: string description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: admin-api-2020-04-events-event_id}.json path: /admin/api/2020-04/events/{event_id}.json operations: - name: deprecated202004geteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-fulfillment_orders-fulfillment_order_id}.json path: /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}.json operations: - name: deprecated202004getfulfillmentordersparamfulfillmentorderid method: GET description: Shopify Retrieves A Specific Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: admin-api-2020-04-fulfillment_orders-fulfillment_order_id-fulfillments.json path: /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillments.json operations: - name: deprecated202004getfulfillmentordersparamfulfillmentorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order that is associated with the fulfillments. - name: admin-api-2020-04-fulfillment_orders-fulfillment_order_id-locations_for_move.jso path: /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json operations: - name: deprecated202004getfulfillmentordersparamfulfillmentorderidlocationsformove method: GET description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order. - name: admin-api-2020-04-gift_cards.json path: /admin/api/2020-04/gift_cards.json operations: - name: deprecated202004getgiftcards method: GET description: Shopify Retrieves A List Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Retrieve gift cards with a given status. Valid values:' - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-gift_cards-count.json path: /admin/api/2020-04/gift_cards/count.json operations: - name: deprecated202004getgiftcardscount method: GET description: Shopify Retrieves A Count Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Count gift cards with a given status. Valid values:' - name: admin-api-2020-04-gift_cards-gift_card_id}.json path: /admin/api/2020-04/gift_cards/{gift_card_id}.json operations: - name: deprecated202004getgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-2020-04-inventory_items.json path: /admin/api/2020-04/inventory_items.json operations: - name: deprecated202004getinventoryitems method: GET description: Shopify Retrieves A List Of Inventory Items outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "ids\n required" in: query type: string description: Show only inventory items specified by a comma-separated list of IDs. - name: limit in: query type: string description: The maximum number of results to show. - name: ids in: query type: integer description: ids - name: admin-api-2020-04-inventory_items-inventory_item_id}.json path: /admin/api/2020-04/inventory_items/{inventory_item_id}.json operations: - name: deprecated202004getinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-2020-04-inventory_levels.json path: /admin/api/2020-04/inventory_levels.json operations: - name: deprecated202004getinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_ids in: query type: string description: A comma-separated list of inventory item IDs. - name: location_ids in: query type: string description: A comma-separated list of location IDs. To find the ID of a location, use the Location resource. - name: limit in: query type: string description: The maximum number of results to show. - name: updated_at_min in: query type: string description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' - name: admin-api-2020-04-locations.json path: /admin/api/2020-04/locations.json operations: - name: deprecated202004getlocations method: GET description: Shopify Retrieves A List Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-locations-count.json path: /admin/api/2020-04/locations/count.json operations: - name: deprecated202004getlocationscount method: GET description: Shopify Retrieves A Count Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-locations-location_id}.json path: /admin/api/2020-04/locations/{location_id}.json operations: - name: deprecated202004getlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-04-locations-location_id-inventory_levels.json path: /admin/api/2020-04/locations/{location_id}/inventory_levels.json operations: - name: deprecated202004getlocationsparamlocationidinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels For A Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-04-metafields.json path: /admin/api/2020-04/metafields.json operations: - name: deprecated202004getmetafields method: GET description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield[owner_id] in: query type: integer description: metafield[owner_id] - name: metafield[owner_resource] in: query type: string description: metafield[owner_resource] - name: admin-api-2020-04-metafields-count.json path: /admin/api/2020-04/metafields/count.json operations: - name: deprecated202004getmetafieldscount method: GET description: Shopify Retrieves A Count Of A Resource's Metafields outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-metafields-metafield_id}.json path: /admin/api/2020-04/metafields/{metafield_id}.json operations: - name: deprecated202004getmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-orders.json path: /admin/api/2020-04/orders.json operations: - name: deprecated202004getorders method: GET description: Shopify Retrieves A List Of Orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Retrieve only orders specified by a comma-separated list of order IDs. - name: limit in: query type: string description: The maximum number of results to show on a page. - name: since_id in: query type: string description: Show orders after the specified ID. - name: created_at_min in: query type: string description: 'Show orders created at or after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00).' - name: processed_at_min in: query type: string description: 'Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00).' - name: processed_at_max in: query type: string description: 'Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00).' - name: attribution_app_id in: query type: string description: Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for the app currently consuming the API. - name: status in: query type: string description: Filter orders by their status. - name: financial_status in: query type: string description: Filter orders by their financial status. - name: fulfillment_status in: query type: string description: Filter orders by their fulfillment status. - name: fields in: query type: string description: Retrieve only certain fields, specified by a comma-separated list of fields names. - name: admin-api-2020-04-orders-count.json path: /admin/api/2020-04/orders/count.json operations: - name: deprecated202004getorderscount method: GET description: Shopify Retrieves An Order Count outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created_at_min in: query type: string description: 'Count orders created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count orders created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count orders last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count orders last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: status in: query type: string description: Count orders of a given status. - name: financial_status in: query type: string description: Count orders of a given financial status. - name: fulfillment_status in: query type: string description: Filter orders by their fulfillment status. - name: admin-api-2020-04-orders-order_id}.json path: /admin/api/2020-04/orders/{order_id}.json operations: - name: deprecated202004getordersparamorderid method: GET description: Shopify Retrieves A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fields in: query type: string description: Retrieve only certain fields, specified by a comma-separated list of fields names. - name: admin-api-2020-04-orders-order_id-fulfillment_orders.json path: /admin/api/2020-04/orders/{order_id}/fulfillment_orders.json operations: - name: deprecated202004getordersparamorderidfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: order_id in: query type: string description: The ID of the order that is associated with the fulfillment orders. - name: admin-api-2020-04-orders-order_id-fulfillments.json path: /admin/api/2020-04/orders/{order_id}/fulfillments.json operations: - name: deprecated202004getordersparamorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_max in: query type: string description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: limit in: query type: string description: Limit the amount of results. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_max in: query type: string description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-04-orders-order_id-fulfillments-count.json path: /admin/api/2020-04/orders/{order_id}/fulfillments/count.json operations: - name: deprecated202004getordersparamorderidfulfillmentscount method: GET description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_min in: query type: string description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-04-orders-order_id-fulfillments-fulfillment_id}.json path: /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}.json operations: - name: deprecated202004getordersparamorderidfulfillmentsparamfulfillmentid method: GET description: Shopify Retrieve A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fields in: query type: string description: Comma-separated list of fields to include in the response. - name: admin-api-2020-04-orders-order_id-fulfillments-fulfillment_id-events.json path: /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.json operations: - name: deprecated202004getordersparamorderidfulfillmentsparamfulfillmentidevents method: GET description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fulfillment_id in: query type: string description: The ID of the fulfillment that's associated with the fulfillment event. - name: order_id in: query type: string description: The ID of the order that's associated with the fulfillment event. - name: admin-api-2020-04-orders-order_id-fulfillments-fulfillment_id-events-event_id}.j path: /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json operations: - name: deprecated202004getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid method: GET description: Shopify Retrieves A Specific Fulfillment Event outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: event_id in: path type: string description: event_id required: true - name: event_id in: query type: string description: The ID of the fulfillment event. - name: admin-api-2020-04-orders-order_id-refunds.json path: /admin/api/2020-04/orders/{order_id}/refunds.json operations: - name: deprecated202004getordersparamorderidrefunds method: GET description: Shopify Retrieves A List Of Refunds For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-2020-04-orders-order_id-refunds-refund_id}.json path: /admin/api/2020-04/orders/{order_id}/refunds/{refund_id}.json operations: - name: deprecated202004getordersparamorderidrefundsparamrefundid method: GET description: Shopify Retrieves A Specific Refund outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: refund_id in: path type: string description: refund_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-2020-04-orders-order_id-risks.json path: /admin/api/2020-04/orders/{order_id}/risks.json operations: - name: deprecated202004getordersparamorderidrisks method: GET description: Shopify Retrieves A List Of All Order Risks For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: admin-api-2020-04-orders-order_id-risks-risk_id}.json path: /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json operations: - name: deprecated202004getordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-2020-04-policies.json path: /admin/api/2020-04/policies.json operations: - name: deprecated202004getpolicies method: GET description: Shopify Retrieves A List Of The Shop's Policies outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-price_rules-price_rule_id-batch-batch_id}.json path: /admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}.json operations: - name: deprecated202004getpricerulesparampriceruleidbatchparambatchid method: GET description: Shopify Retrieves A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-2020-04-price_rules-price_rule_id-batch-batch_id-discount_codes.json path: /admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json operations: - name: deprecated202004getpricerulesparampriceruleidbatchparambatchiddiscountcodes method: GET description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-2020-04-price_rules-price_rule_id-discount_codes.json path: /admin/api/2020-04/price_rules/{price_rule_id}/discount_codes.json operations: - name: deprecated202004getpricerulesparampriceruleiddiscountcodes method: GET description: Shopify Retrieve A List Of Discount Codes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: admin-api-2020-04-price_rules-price_rule_id-discount_codes-discount_code_id}.jso path: /admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: deprecated202004getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-2020-04-product_listings.json path: /admin/api/2020-04/product_listings.json operations: - name: deprecated202004getproductlistings method: GET description: Shopify Retrieve Product Listings That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_ids in: query type: string description: A comma-separated list of product ids - name: limit in: query type: string description: Amount of results - name: collection_id in: query type: string description: Filter by products belonging to a particular collection - name: updated_at_min in: query type: string description: Filter by products last updated after a certain date and time (formatted in ISO 8601) - name: handle in: query type: string description: Filter by product handle - name: admin-api-2020-04-product_listings-count.json path: /admin/api/2020-04/product_listings/count.json operations: - name: deprecated202004getproductlistingscount method: GET description: Shopify Retrieve A Count Of Products That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-product_listings-product_ids.json path: /admin/api/2020-04/product_listings/product_ids.json operations: - name: deprecated202004getproductlistingsproductids method: GET description: Shopify Retrieve Product_ids That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: Amount of results - name: admin-api-2020-04-product_listings-product_listing_id}.json path: /admin/api/2020-04/product_listings/{product_listing_id}.json operations: - name: deprecated202004getproductlistingsparamproductlistingid method: GET description: Shopify Retrieve A Specific Product Listing That Is Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_listing_id in: path type: string description: product_listing_id required: true - name: admin-api-2020-04-products.json path: /admin/api/2020-04/products.json operations: - name: deprecated202004getproducts method: GET description: Shopify Retrieves A List Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Return only products specified by a comma-separated list of product IDs. - name: limit in: query type: string description: Return up to this many results per page. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Filter results by product title. - name: vendor in: query type: string description: Filter results by product vendor. - name: handle in: query type: string description: Filter results by product handle. - name: product_type in: query type: string description: Filter results by product type. - name: status in: query type: string description: Return products by their status. - name: collection_id in: query type: string description: Filter results by product collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: presentment_currencies in: query type: string description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. - name: admin-api-2020-04-products-count.json path: /admin/api/2020-04/products/count.json operations: - name: deprecated202004getproductscount method: GET description: Shopify Retrieves A Count Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: vendor in: query type: string description: Filter results by product vendor. - name: product_type in: query type: string description: Filter results by product type. - name: collection_id in: query type: string description: Filter results by collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: admin-api-2020-04-products-product_id}.json path: /admin/api/2020-04/products/{product_id}.json operations: - name: deprecated202004getproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-04-redirects.json path: /admin/api/2020-04/redirects.json operations: - name: deprecated202004getredirects method: GET description: Shopify Retrieves A List Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: path in: query type: string description: Show redirects with a given path. - name: target in: query type: string description: Show redirects with a given target. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-redirects-count.json path: /admin/api/2020-04/redirects/count.json operations: - name: deprecated202004getredirectscount method: GET description: Shopify Retrieves A Count Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: path in: query type: string description: Count redirects with given path. - name: target in: query type: string description: Count redirects with given target. - name: admin-api-2020-04-redirects-redirect_id}.json path: /admin/api/2020-04/redirects/{redirect_id}.json operations: - name: deprecated202004getredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-script_tags.json path: /admin/api/2020-04/script_tags.json operations: - name: deprecated202004getscripttags method: GET description: Shopify Retrieves A List Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: src in: query type: string description: Show script tags with this URL. - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-04-script_tags-count.json path: /admin/api/2020-04/script_tags/count.json operations: - name: deprecated202004getscripttagscount method: GET description: Shopify Retrieves A Count Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: src in: query type: string description: Count only script tags with a given URL. - name: admin-api-2020-04-script_tags-script_tag_id}.json path: /admin/api/2020-04/script_tags/{script_tag_id}.json operations: - name: deprecated202004getscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-04-shop.json path: /admin/api/2020-04/shop.json operations: - name: deprecated202004getshop method: GET description: Shopify Retrieves The Shop's Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-04-shopify_payments-balance.json path: /admin/api/2020-04/shopify_payments/balance.json operations: - name: deprecated202004getshopifypaymentsbalance method: GET description: Shopify Retrieves The Account's Current Balance outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-shopify_payments-disputes.json path: /admin/api/2020-04/shopify_payments/disputes.json operations: - name: deprecated202004getshopifypaymentsdisputes method: GET description: Shopify Retrieve All Disputes Ordered By Initiated_at Date And Time (iso 8601 Format) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Return only disputes after the specified ID. - name: last_id in: query type: string description: Return only disputes before the specified ID. - name: status in: query type: string description: Return only disputes with the specified status. - name: initiated_at in: query type: string description: Return only disputes with the specified initiated_at date (ISO 8601 format). - name: admin-api-2020-04-shopify_payments-payouts.json path: /admin/api/2020-04/shopify_payments/payouts.json operations: - name: deprecated202004getshopifypaymentspayouts method: GET description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Filter the response to payouts made after the specified ID. - name: last_id in: query type: string description: Filter the response to payouts made before the specified ID. - name: date_min in: query type: string description: Filter the response to payouts made inclusively after the specified date. - name: date_max in: query type: string description: Filter the response to payouts made inclusively before the specified date. - name: date in: query type: string description: Filter the response to payouts made on the specified date. - name: status in: query type: string description: Filter the response to payouts made with the specified status. - name: admin-api-2020-04-shopify_payments-payouts-payout_id}.json path: /admin/api/2020-04/shopify_payments/payouts/{payout_id}.json operations: - name: deprecated202004getshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-2020-04-smart_collections.json path: /admin/api/2020-04/smart_collections.json operations: - name: deprecated202004getsmartcollections method: GET description: Shopify Retrieves A List Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: ids in: query type: string description: Show only the smart collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that includes the specified product. - name: handle in: query type: string description: Filter results by smart collection handle. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-smart_collections-count.json path: /admin/api/2020-04/smart_collections/count.json operations: - name: deprecated202004getsmartcollectionscount method: GET description: Shopify Retrieves A Count Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that include the specified product. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: admin-api-2020-04-smart_collections-smart_collection_id}.json path: /admin/api/2020-04/smart_collections/{smart_collection_id}.json operations: - name: deprecated202004getsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-tender_transactions.json path: /admin/api/2020-04/tender_transactions.json operations: - name: deprecated202004gettendertransactions method: GET description: Shopify Retrieves A List Of Tender Transactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Retrieve only transactions after the specified ID. - name: processed_at_min in: query type: string description: Show tender transactions processed_at or after the specified date. - name: processed_at_max in: query type: string description: Show tender transactions processed_at or before the specified date. - name: processed_at in: query type: string description: Show tender transactions processed at the specified date. - name: order in: query type: string description: Show tender transactions ordered by processed_at in ascending or descending order. - name: admin-api-2020-04-themes.json path: /admin/api/2020-04/themes.json operations: - name: deprecated202004getthemes method: GET description: Shopify Retrieves A List Of Themes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-themes-theme_id}.json path: /admin/api/2020-04/themes/{theme_id}.json operations: - name: deprecated202004getthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-themes-theme_id-assets.json path: /admin/api/2020-04/themes/{theme_id}/assets.json operations: - name: deprecated202004getthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-2020-04-users.json path: /admin/api/2020-04/users.json operations: - name: deprecated202004getusers method: GET description: Shopify Retrieves A List Of All Users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show on a page. - name: page_info in: query type: string description: A unique ID used to access a certain page of results. - name: admin-api-2020-04-users-current.json path: /admin/api/2020-04/users/current.json operations: - name: deprecated202004getuserscurrent method: GET description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-04-users-user_id}.json path: /admin/api/2020-04/users/{user_id}.json operations: - name: deprecated202004getusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-2020-04-webhooks.json path: /admin/api/2020-04/webhooks.json operations: - name: deprecated202004getwebhooks method: GET description: Shopify Retrieves A List Of Webhooks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: created_at_max in: query type: string description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: limit in: query type: string description: Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error. - name: since_id in: query type: string description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: updated_at_min in: query type: string description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-04-webhooks-count.json path: /admin/api/2020-04/webhooks/count.json operations: - name: deprecated202004getwebhookscount method: GET description: Shopify Retrieves A Count Of Existing Webhook Subscriptions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: admin-api-2020-04-webhooks-webhook_id}.json path: /admin/api/2020-04/webhooks/{webhook_id}.json operations: - name: deprecated202004getwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: admin-api-2020-07-articles-authors.json path: /admin/api/2020-07/articles/authors.json operations: - name: deprecated202007getarticlesauthors method: GET description: Shopify Retrieves A List All Of Article Authors outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-articles-tags.json path: /admin/api/2020-07/articles/tags.json operations: - name: deprecated202007getarticlestags method: GET description: Shopify Retrieves A List Of All The Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of tags to retrieve. - name: popular in: query type: string description: A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag. - name: admin-api-2020-07-assigned_fulfillment_orders.json path: /admin/api/2020-07/assigned_fulfillment_orders.json operations: - name: deprecated202007getassignedfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: assignment_status in: query type: string description: 'The assigment status of the fulfillment orders that should be returned:' - name: location_ids in: query type: string description: The IDs of the assigned locations of the fulfillment orders that should be returned. - name: location_ids[] in: query type: integer description: location_ids[] - name: admin-api-2020-07-blogs-blog_id-articles.json path: /admin/api/2020-07/blogs/{blog_id}/articles.json operations: - name: deprecated202007getblogsparamblogidarticles method: GET description: Shopify Retrieves A List Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Retrieve results based on their published status. - name: handle in: query type: string description: Retrieve an article with a specific handle. - name: tag in: query type: string description: Filter articles with a specific tag. - name: author in: query type: string description: Filter articles by article author. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-blogs-blog_id-articles-count.json path: /admin/api/2020-07/blogs/{blog_id}/articles/count.json operations: - name: deprecated202007getblogsparamblogidarticlescount method: GET description: Shopify Retrieves A Count Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: created_at_min in: query type: string description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count articles with a given published status. - name: admin-api-2020-07-blogs-blog_id-articles-article_id}.json path: /admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.json operations: - name: deprecated202007getblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-2020-07-carrier_services.json path: /admin/api/2020-07/carrier_services.json operations: - name: deprecated202007getcarrierservices method: GET description: Shopify Retrieves A List Of Carrier Services outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-carrier_services-carrier_service_id}.json path: /admin/api/2020-07/carrier_services/{carrier_service_id}.json operations: - name: deprecated202007getcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-2020-07-checkouts-count.json path: /admin/api/2020-07/checkouts/count.json operations: - name: deprecated202007getcheckoutscount method: GET description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: status in: query type: string description: Count checkouts with a given status. - name: admin-api-2020-07-checkouts-token}.json path: /admin/api/2020-07/checkouts/{token}.json operations: - name: deprecated202007getcheckoutsparamtoken method: GET description: Shopify Retrieves A Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-07-checkouts-token-payments.json path: /admin/api/2020-07/checkouts/{token}/payments.json operations: - name: deprecated202007getcheckoutsparamtokenpayments method: GET description: Shopify Retrieves A List Of Payments On A Particular Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-07-checkouts-token-payments-payment_id}.json path: /admin/api/2020-07/checkouts/{token}/payments/{payment_id}.json operations: - name: deprecated202007getcheckoutsparamtokenpaymentsparampaymentid method: GET description: Shopify Retrieves The Payment Information For An Existing Payment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: payment_id in: path type: string description: payment_id required: true - name: admin-api-2020-07-checkouts-token-shipping_rates.json path: /admin/api/2020-07/checkouts/{token}/shipping_rates.json operations: - name: deprecated202007getcheckoutsparamtokenshippingrates method: GET description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-07-collection_listings.json path: /admin/api/2020-07/collection_listings.json operations: - name: deprecated202007getcollectionlistings method: GET description: Shopify Retrieve Collection Listings That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: Amount of results - name: admin-api-2020-07-collection_listings-collection_listing_id}.json path: /admin/api/2020-07/collection_listings/{collection_listing_id}.json operations: - name: deprecated202007getcollectionlistingsparamcollectionlistingid method: GET description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: admin-api-2020-07-collection_listings-collection_listing_id-product_ids.json path: /admin/api/2020-07/collection_listings/{collection_listing_id}/product_ids.json operations: - name: deprecated202007getcollectionlistingsparamcollectionlistingidproductids method: GET description: Shopify Retrieve Product_ids That Are Published To A Collection_id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: limit in: query type: string description: Amount of results - name: admin-api-2020-07-collections-collection_id}.json path: /admin/api/2020-07/collections/{collection_id}.json operations: - name: deprecated202007getcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-collections-collection_id-products.json path: /admin/api/2020-07/collections/{collection_id}/products.json operations: - name: deprecated202007getcollectionsparamcollectionidproducts method: GET description: Shopify Retrieve A List Of Products Belonging To A Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: limit in: query type: string description: The number of products to retrieve. - name: admin-api-2020-07-collects.json path: /admin/api/2020-07/collects.json operations: - name: deprecated202007getcollects method: GET description: Shopify Retrieves A List Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-collects-count.json path: /admin/api/2020-07/collects/count.json operations: - name: deprecated202007getcollectscount method: GET description: Shopify Retrieves A Count Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: query type: integer description: collection_id - name: admin-api-2020-07-collects-collect_id}.json path: /admin/api/2020-07/collects/{collect_id}.json operations: - name: deprecated202007getcollectsparamcollectid method: GET description: Shopify Retrieves A Specific Collect By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collect_id in: path type: string description: collect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-countries.json path: /admin/api/2020-07/countries.json operations: - name: deprecated202007getcountries method: GET description: Shopify Retrieves A List Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-countries-count.json path: /admin/api/2020-07/countries/count.json operations: - name: deprecated202007getcountriescount method: GET description: Shopify Retrieves A Count Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-countries-country_id}.json path: /admin/api/2020-07/countries/{country_id}.json operations: - name: deprecated202007getcountriesparamcountryid method: GET description: Shopify Retrieves A Specific County outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-countries-country_id-provinces.json path: /admin/api/2020-07/countries/{country_id}/provinces.json operations: - name: deprecated202007getcountriesparamcountryidprovinces method: GET description: Shopify Retrieves A List Of Provinces outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of fields names. - name: admin-api-2020-07-countries-country_id-provinces-count.json path: /admin/api/2020-07/countries/{country_id}/provinces/count.json operations: - name: deprecated202007getcountriesparamcountryidprovincescount method: GET description: Shopify Retrieves A Count Of Provinces For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: admin-api-2020-07-countries-country_id-provinces-province_id}.json path: /admin/api/2020-07/countries/{country_id}/provinces/{province_id}.json operations: - name: deprecated202007getcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-currencies.json path: /admin/api/2020-07/currencies.json operations: - name: deprecated202007getcurrencies method: GET description: Shopify Retrieves A List Of Currencies Enabled On A Shop outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-custom_collections.json path: /admin/api/2020-07/custom_collections.json operations: - name: deprecated202007getcustomcollections method: GET description: Shopify Retrieves A List Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: ids in: query type: string description: Show only collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show custom collections with a given title. - name: product_id in: query type: string description: Show custom collections that include a given product. - name: handle in: query type: string description: Filter by custom collection handle. - name: updated_at_min in: query type: string description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Show custom collectsion with a given published status. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-custom_collections-count.json path: /admin/api/2020-07/custom_collections/count.json operations: - name: deprecated202007getcustomcollectionscount method: GET description: Shopify Retrieves A Count Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Count custom collections with given title. - name: product_id in: query type: string description: Count custom collections that include a given product. - name: updated_at_min in: query type: string description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count custom collections with a given published status. - name: admin-api-2020-07-custom_collections-custom_collection_id}.json path: /admin/api/2020-07/custom_collections/{custom_collection_id}.json operations: - name: deprecated202007getcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-customer_saved_searches.json path: /admin/api/2020-07/customer_saved_searches.json operations: - name: deprecated202007getcustomersavedsearches method: GET description: Shopify Retrieves A List Of Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-customer_saved_searches-count.json path: /admin/api/2020-07/customer_saved_searches/count.json operations: - name: deprecated202007getcustomersavedsearchescount method: GET description: Shopify Retrieves A Count Of All Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID - name: admin-api-2020-07-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json operations: - name: deprecated202007getcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-customer_saved_searches-customer_saved_search_id-customers.jso path: /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}/customers.json operations: - name: deprecated202007getcustomersavedsearchesparamcustomersavedsearchidcustomers method: GET description: Shopify Retrieves All Customers Returned By A Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: order in: query type: string description: Set the field and direction by which to order results. - name: limit in: query type: string description: The maximum number of results to show. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-customers-customer_id-addresses.json path: /admin/api/2020-07/customers/{customer_id}/addresses.json operations: - name: deprecated202007getcustomersparamcustomeridaddresses method: GET description: Shopify Retrieves A List Of Addresses For A Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: admin-api-2020-07-customers-customer_id-addresses-address_id}.json path: /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json operations: - name: deprecated202007getcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-2020-07-discount_codes-lookup.json path: /admin/api/2020-07/discount_codes/lookup.json operations: - name: deprecated202007getdiscountcodeslookup method: GET description: Shopify Retrieves The Location Of A Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: code in: query type: integer description: code - name: admin-api-2020-07-events.json path: /admin/api/2020-07/events.json operations: - name: deprecated202007getevents method: GET description: Shopify Retrieves A List Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: since_id in: query type: string description: Show only results after the specified ID. - name: created_at_min in: query type: string description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: filter in: query type: string description: Show events specified in this filter. - name: verb in: query type: string description: Show events of a certain type. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-events-count.json path: /admin/api/2020-07/events/count.json operations: - name: deprecated202007geteventscount method: GET description: Shopify Retrieves A Count Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created_at_min in: query type: string description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: admin-api-2020-07-events-event_id}.json path: /admin/api/2020-07/events/{event_id}.json operations: - name: deprecated202007geteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-fulfillment_orders-fulfillment_order_id}.json path: /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}.json operations: - name: deprecated202007getfulfillmentordersparamfulfillmentorderid method: GET description: Shopify Retrieves A Specific Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: admin-api-2020-07-fulfillment_orders-fulfillment_order_id-fulfillments.json path: /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillments.json operations: - name: deprecated202007getfulfillmentordersparamfulfillmentorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order that is associated with the fulfillments. - name: admin-api-2020-07-fulfillment_orders-fulfillment_order_id-locations_for_move.jso path: /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json operations: - name: deprecated202007getfulfillmentordersparamfulfillmentorderidlocationsformove method: GET description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order. - name: admin-api-2020-07-gift_cards.json path: /admin/api/2020-07/gift_cards.json operations: - name: deprecated202007getgiftcards method: GET description: Shopify Retrieves A List Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Retrieve gift cards with a given status. Valid values:' - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-gift_cards-count.json path: /admin/api/2020-07/gift_cards/count.json operations: - name: deprecated202007getgiftcardscount method: GET description: Shopify Retrieves A Count Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Count gift cards with a given status. Valid values:' - name: admin-api-2020-07-gift_cards-gift_card_id}.json path: /admin/api/2020-07/gift_cards/{gift_card_id}.json operations: - name: deprecated202007getgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-2020-07-inventory_items.json path: /admin/api/2020-07/inventory_items.json operations: - name: deprecated202007getinventoryitems method: GET description: Shopify Retrieves A List Of Inventory Items outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "ids\n required" in: query type: string description: Show only inventory items specified by a comma-separated list of IDs. - name: limit in: query type: string description: The maximum number of results to show. - name: ids in: query type: integer description: ids - name: admin-api-2020-07-inventory_items-inventory_item_id}.json path: /admin/api/2020-07/inventory_items/{inventory_item_id}.json operations: - name: deprecated202007getinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-2020-07-inventory_levels.json path: /admin/api/2020-07/inventory_levels.json operations: - name: deprecated202007getinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_ids in: query type: string description: A comma-separated list of inventory item IDs. - name: location_ids in: query type: string description: A comma-separated list of location IDs. To find the ID of a location, use the Location resource. - name: limit in: query type: string description: The maximum number of results to show. - name: updated_at_min in: query type: string description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' - name: admin-api-2020-07-locations.json path: /admin/api/2020-07/locations.json operations: - name: deprecated202007getlocations method: GET description: Shopify Retrieves A List Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-locations-count.json path: /admin/api/2020-07/locations/count.json operations: - name: deprecated202007getlocationscount method: GET description: Shopify Retrieves A Count Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-locations-location_id}.json path: /admin/api/2020-07/locations/{location_id}.json operations: - name: deprecated202007getlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-07-locations-location_id-inventory_levels.json path: /admin/api/2020-07/locations/{location_id}/inventory_levels.json operations: - name: deprecated202007getlocationsparamlocationidinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels For A Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-07-metafields.json path: /admin/api/2020-07/metafields.json operations: - name: deprecated202007getmetafields method: GET description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield[owner_id] in: query type: integer description: metafield[owner_id] - name: metafield[owner_resource] in: query type: string description: metafield[owner_resource] - name: admin-api-2020-07-metafields-count.json path: /admin/api/2020-07/metafields/count.json operations: - name: deprecated202007getmetafieldscount method: GET description: Shopify Retrieves A Count Of A Resource's Metafields outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-metafields-metafield_id}.json path: /admin/api/2020-07/metafields/{metafield_id}.json operations: - name: deprecated202007getmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-orders.json path: /admin/api/2020-07/orders.json operations: - name: deprecated202007getorders method: GET description: Shopify Retrieves A List Of Orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Retrieve only orders specified by a comma-separated list of order IDs. - name: limit in: query type: string description: The maximum number of results to show on a page. - name: since_id in: query type: string description: Show orders after the specified ID. - name: created_at_min in: query type: string description: 'Show orders created at or after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00).' - name: processed_at_min in: query type: string description: 'Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00).' - name: processed_at_max in: query type: string description: 'Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00).' - name: attribution_app_id in: query type: string description: Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for the app currently consuming the API. - name: status in: query type: string description: Filter orders by their status. - name: financial_status in: query type: string description: Filter orders by their financial status. - name: fulfillment_status in: query type: string description: Filter orders by their fulfillment status. - name: fields in: query type: string description: Retrieve only certain fields, specified by a comma-separated list of fields names. - name: admin-api-2020-07-orders-order_id-fulfillment_orders.json path: /admin/api/2020-07/orders/{order_id}/fulfillment_orders.json operations: - name: deprecated202007getordersparamorderidfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: order_id in: query type: string description: The ID of the order that is associated with the fulfillment orders. - name: admin-api-2020-07-orders-order_id-fulfillments.json path: /admin/api/2020-07/orders/{order_id}/fulfillments.json operations: - name: deprecated202007getordersparamorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_max in: query type: string description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: limit in: query type: string description: Limit the amount of results. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_max in: query type: string description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-07-orders-order_id-fulfillments-count.json path: /admin/api/2020-07/orders/{order_id}/fulfillments/count.json operations: - name: deprecated202007getordersparamorderidfulfillmentscount method: GET description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_min in: query type: string description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-07-orders-order_id-fulfillments-fulfillment_id}.json path: /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.json operations: - name: deprecated202007getordersparamorderidfulfillmentsparamfulfillmentid method: GET description: Shopify Retrieve A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fields in: query type: string description: Comma-separated list of fields to include in the response. - name: admin-api-2020-07-orders-order_id-fulfillments-fulfillment_id-events.json path: /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events.json operations: - name: deprecated202007getordersparamorderidfulfillmentsparamfulfillmentidevents method: GET description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fulfillment_id in: query type: string description: The ID of the fulfillment that's associated with the fulfillment event. - name: order_id in: query type: string description: The ID of the order that's associated with the fulfillment event. - name: admin-api-2020-07-orders-order_id-fulfillments-fulfillment_id-events-event_id}.j path: /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json operations: - name: deprecated202007getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid method: GET description: Shopify Retrieves A Specific Fulfillment Event outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: event_id in: path type: string description: event_id required: true - name: event_id in: query type: string description: The ID of the fulfillment event. - name: admin-api-2020-07-orders-order_id-refunds.json path: /admin/api/2020-07/orders/{order_id}/refunds.json operations: - name: deprecated202007getordersparamorderidrefunds method: GET description: Shopify Retrieves A List Of Refunds For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-2020-07-orders-order_id-refunds-refund_id}.json path: /admin/api/2020-07/orders/{order_id}/refunds/{refund_id}.json operations: - name: deprecated202007getordersparamorderidrefundsparamrefundid method: GET description: Shopify Retrieves A Specific Refund outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: refund_id in: path type: string description: refund_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-2020-07-orders-order_id-risks.json path: /admin/api/2020-07/orders/{order_id}/risks.json operations: - name: deprecated202007getordersparamorderidrisks method: GET description: Shopify Retrieves A List Of All Order Risks For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: admin-api-2020-07-orders-order_id-risks-risk_id}.json path: /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json operations: - name: deprecated202007getordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-2020-07-policies.json path: /admin/api/2020-07/policies.json operations: - name: deprecated202007getpolicies method: GET description: Shopify Retrieves A List Of The Shop's Policies outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-price_rules-price_rule_id-batch-batch_id}.json path: /admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}.json operations: - name: deprecated202007getpricerulesparampriceruleidbatchparambatchid method: GET description: Shopify Retrieves A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-2020-07-price_rules-price_rule_id-batch-batch_id-discount_codes.json path: /admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json operations: - name: deprecated202007getpricerulesparampriceruleidbatchparambatchiddiscountcodes method: GET description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-2020-07-price_rules-price_rule_id-discount_codes.json path: /admin/api/2020-07/price_rules/{price_rule_id}/discount_codes.json operations: - name: deprecated202007getpricerulesparampriceruleiddiscountcodes method: GET description: Shopify Retrieve A List Of Discount Codes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: admin-api-2020-07-price_rules-price_rule_id-discount_codes-discount_code_id}.jso path: /admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: deprecated202007getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-2020-07-product_listings.json path: /admin/api/2020-07/product_listings.json operations: - name: deprecated202007getproductlistings method: GET description: Shopify Retrieve Product Listings That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_ids in: query type: string description: A comma-separated list of product ids - name: limit in: query type: string description: Amount of results - name: collection_id in: query type: string description: Filter by products belonging to a particular collection - name: updated_at_min in: query type: string description: Filter by products last updated after a certain date and time (formatted in ISO 8601) - name: handle in: query type: string description: Filter by product handle - name: admin-api-2020-07-product_listings-count.json path: /admin/api/2020-07/product_listings/count.json operations: - name: deprecated202007getproductlistingscount method: GET description: Shopify Retrieve A Count Of Products That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-product_listings-product_ids.json path: /admin/api/2020-07/product_listings/product_ids.json operations: - name: deprecated202007getproductlistingsproductids method: GET description: Shopify Retrieve Product_ids That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: Amount of results - name: admin-api-2020-07-product_listings-product_listing_id}.json path: /admin/api/2020-07/product_listings/{product_listing_id}.json operations: - name: deprecated202007getproductlistingsparamproductlistingid method: GET description: Shopify Retrieve A Specific Product Listing That Is Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_listing_id in: path type: string description: product_listing_id required: true - name: admin-api-2020-07-products.json path: /admin/api/2020-07/products.json operations: - name: deprecated202007getproducts method: GET description: Shopify Retrieves A List Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Return only products specified by a comma-separated list of product IDs. - name: limit in: query type: string description: Return up to this many results per page. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Filter results by product title. - name: vendor in: query type: string description: Filter results by product vendor. - name: handle in: query type: string description: Filter results by product handle. - name: product_type in: query type: string description: Filter results by product type. - name: status in: query type: string description: Return products by their status. - name: collection_id in: query type: string description: Filter results by product collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: presentment_currencies in: query type: string description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. - name: admin-api-2020-07-products-count.json path: /admin/api/2020-07/products/count.json operations: - name: deprecated202007getproductscount method: GET description: Shopify Retrieves A Count Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: vendor in: query type: string description: Filter results by product vendor. - name: product_type in: query type: string description: Filter results by product type. - name: collection_id in: query type: string description: Filter results by collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: admin-api-2020-07-products-product_id}.json path: /admin/api/2020-07/products/{product_id}.json operations: - name: deprecated202007getproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-07-redirects.json path: /admin/api/2020-07/redirects.json operations: - name: deprecated202007getredirects method: GET description: Shopify Retrieves A List Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: path in: query type: string description: Show redirects with a given path. - name: target in: query type: string description: Show redirects with a given target. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-redirects-count.json path: /admin/api/2020-07/redirects/count.json operations: - name: deprecated202007getredirectscount method: GET description: Shopify Retrieves A Count Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: path in: query type: string description: Count redirects with given path. - name: target in: query type: string description: Count redirects with given target. - name: admin-api-2020-07-redirects-redirect_id}.json path: /admin/api/2020-07/redirects/{redirect_id}.json operations: - name: deprecated202007getredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-script_tags.json path: /admin/api/2020-07/script_tags.json operations: - name: deprecated202007getscripttags method: GET description: Shopify Retrieves A List Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: src in: query type: string description: Show script tags with this URL. - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-07-script_tags-count.json path: /admin/api/2020-07/script_tags/count.json operations: - name: deprecated202007getscripttagscount method: GET description: Shopify Retrieves A Count Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: src in: query type: string description: Count only script tags with a given URL. - name: admin-api-2020-07-script_tags-script_tag_id}.json path: /admin/api/2020-07/script_tags/{script_tag_id}.json operations: - name: deprecated202007getscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-07-shop.json path: /admin/api/2020-07/shop.json operations: - name: deprecated202007getshop method: GET description: Shopify Retrieves The Shop's Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-07-shopify_payments-balance.json path: /admin/api/2020-07/shopify_payments/balance.json operations: - name: deprecated202007getshopifypaymentsbalance method: GET description: Shopify Retrieves The Account's Current Balance outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-shopify_payments-payouts.json path: /admin/api/2020-07/shopify_payments/payouts.json operations: - name: deprecated202007getshopifypaymentspayouts method: GET description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Filter the response to payouts made after the specified ID. - name: last_id in: query type: string description: Filter the response to payouts made before the specified ID. - name: date_min in: query type: string description: Filter the response to payouts made inclusively after the specified date. - name: date_max in: query type: string description: Filter the response to payouts made inclusively before the specified date. - name: date in: query type: string description: Filter the response to payouts made on the specified date. - name: status in: query type: string description: Filter the response to payouts made with the specified status. - name: admin-api-2020-07-shopify_payments-payouts-payout_id}.json path: /admin/api/2020-07/shopify_payments/payouts/{payout_id}.json operations: - name: deprecated202007getshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-2020-07-smart_collections.json path: /admin/api/2020-07/smart_collections.json operations: - name: deprecated202007getsmartcollections method: GET description: Shopify Retrieves A List Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: ids in: query type: string description: Show only the smart collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that includes the specified product. - name: handle in: query type: string description: Filter results by smart collection handle. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-smart_collections-count.json path: /admin/api/2020-07/smart_collections/count.json operations: - name: deprecated202007getsmartcollectionscount method: GET description: Shopify Retrieves A Count Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that include the specified product. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: admin-api-2020-07-smart_collections-smart_collection_id}.json path: /admin/api/2020-07/smart_collections/{smart_collection_id}.json operations: - name: deprecated202007getsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-tender_transactions.json path: /admin/api/2020-07/tender_transactions.json operations: - name: deprecated202007gettendertransactions method: GET description: Shopify Retrieves A List Of Tender Transactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Retrieve only transactions after the specified ID. - name: processed_at_min in: query type: string description: Show tender transactions processed_at or after the specified date. - name: processed_at_max in: query type: string description: Show tender transactions processed_at or before the specified date. - name: processed_at in: query type: string description: Show tender transactions processed at the specified date. - name: order in: query type: string description: Show tender transactions ordered by processed_at in ascending or descending order. - name: admin-api-2020-07-themes.json path: /admin/api/2020-07/themes.json operations: - name: deprecated202007getthemes method: GET description: Shopify Retrieves A List Of Themes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-themes-theme_id}.json path: /admin/api/2020-07/themes/{theme_id}.json operations: - name: deprecated202007getthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-themes-theme_id-assets.json path: /admin/api/2020-07/themes/{theme_id}/assets.json operations: - name: deprecated202007getthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-2020-07-users.json path: /admin/api/2020-07/users.json operations: - name: deprecated202007getusers method: GET description: Shopify Retrieves A List Of All Users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show on a page. - name: page_info in: query type: string description: A unique ID used to access a certain page of results. - name: admin-api-2020-07-users-current.json path: /admin/api/2020-07/users/current.json operations: - name: deprecated202007getuserscurrent method: GET description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-07-users-user_id}.json path: /admin/api/2020-07/users/{user_id}.json operations: - name: deprecated202007getusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-2020-07-webhooks.json path: /admin/api/2020-07/webhooks.json operations: - name: deprecated202007getwebhooks method: GET description: Shopify Retrieves A List Of Webhooks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: created_at_max in: query type: string description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: limit in: query type: string description: Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error. - name: since_id in: query type: string description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: updated_at_min in: query type: string description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-07-webhooks-count.json path: /admin/api/2020-07/webhooks/count.json operations: - name: deprecated202007getwebhookscount method: GET description: Shopify Retrieves A Count Of Existing Webhook Subscriptions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: admin-api-2020-07-webhooks-webhook_id}.json path: /admin/api/2020-07/webhooks/{webhook_id}.json operations: - name: deprecated202007getwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: admin-api-2020-10-articles-authors.json path: /admin/api/2020-10/articles/authors.json operations: - name: getarticlesauthors method: GET description: Shopify Retrieves A List All Of Article Authors outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-10-articles-tags.json path: /admin/api/2020-10/articles/tags.json operations: - name: getarticlestags method: GET description: Shopify Retrieves A List Of All The Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of tags to retrieve. - name: popular in: query type: string description: A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag. - name: admin-api-2020-10-assigned_fulfillment_orders.json path: /admin/api/2020-10/assigned_fulfillment_orders.json operations: - name: getassignedfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: assignment_status in: query type: string description: 'The assigment status of the fulfillment orders that should be returned:' - name: location_ids in: query type: string description: The IDs of the assigned locations of the fulfillment orders that should be returned. - name: location_ids[] in: query type: integer description: location_ids[] - name: admin-api-2020-10-blogs-blog_id-articles.json path: /admin/api/2020-10/blogs/{blog_id}/articles.json operations: - name: getblogsparamblogidarticles method: GET description: Shopify Retrieves A List Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Retrieve results based on their published status. - name: handle in: query type: string description: Retrieve an article with a specific handle. - name: tag in: query type: string description: Filter articles with a specific tag. - name: author in: query type: string description: Filter articles by article author. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-blogs-blog_id-articles-count.json path: /admin/api/2020-10/blogs/{blog_id}/articles/count.json operations: - name: getblogsparamblogidarticlescount method: GET description: Shopify Retrieves A Count Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: created_at_min in: query type: string description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count articles with a given published status. - name: admin-api-2020-10-blogs-blog_id-articles-article_id}.json path: /admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.json operations: - name: getblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-2020-10-carrier_services.json path: /admin/api/2020-10/carrier_services.json operations: - name: getcarrierservices method: GET description: Shopify Retrieves A List Of Carrier Services outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-10-carrier_services-carrier_service_id}.json path: /admin/api/2020-10/carrier_services/{carrier_service_id}.json operations: - name: getcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-2020-10-checkouts-count.json path: /admin/api/2020-10/checkouts/count.json operations: - name: getcheckoutscount method: GET description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: status in: query type: string description: Count checkouts with a given status. - name: admin-api-2020-10-checkouts-token}.json path: /admin/api/2020-10/checkouts/{token}.json operations: - name: getcheckoutsparamtoken method: GET description: Shopify Retrieves A Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-10-checkouts-token-payments.json path: /admin/api/2020-10/checkouts/{token}/payments.json operations: - name: getcheckoutsparamtokenpayments method: GET description: Shopify Retrieves A List Of Payments On A Particular Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-10-checkouts-token-payments-payment_id}.json path: /admin/api/2020-10/checkouts/{token}/payments/{payment_id}.json operations: - name: getcheckoutsparamtokenpaymentsparampaymentid method: GET description: Shopify Retrieves The Payment Information For An Existing Payment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: payment_id in: path type: string description: payment_id required: true - name: admin-api-2020-10-checkouts-token-shipping_rates.json path: /admin/api/2020-10/checkouts/{token}/shipping_rates.json operations: - name: getcheckoutsparamtokenshippingrates method: GET description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2020-10-collection_listings.json path: /admin/api/2020-10/collection_listings.json operations: - name: getcollectionlistings method: GET description: Shopify Retrieve Collection Listings That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: Amount of results - name: admin-api-2020-10-collection_listings-collection_listing_id}.json path: /admin/api/2020-10/collection_listings/{collection_listing_id}.json operations: - name: getcollectionlistingsparamcollectionlistingid method: GET description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: admin-api-2020-10-collection_listings-collection_listing_id-product_ids.json path: /admin/api/2020-10/collection_listings/{collection_listing_id}/product_ids.json operations: - name: getcollectionlistingsparamcollectionlistingidproductids method: GET description: Shopify Retrieve Product_ids That Are Published To A Collection_id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: limit in: query type: string description: Amount of results - name: admin-api-2020-10-collections-collection_id}.json path: /admin/api/2020-10/collections/{collection_id}.json operations: - name: getcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-collections-collection_id-products.json path: /admin/api/2020-10/collections/{collection_id}/products.json operations: - name: getcollectionsparamcollectionidproducts method: GET description: Shopify Retrieve A List Of Products Belonging To A Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: limit in: query type: string description: The number of products to retrieve. - name: admin-api-2020-10-collects.json path: /admin/api/2020-10/collects.json operations: - name: getcollects method: GET description: Shopify Retrieves A List Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-collects-count.json path: /admin/api/2020-10/collects/count.json operations: - name: getcollectscount method: GET description: Shopify Retrieves A Count Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: query type: integer description: collection_id - name: admin-api-2020-10-collects-collect_id}.json path: /admin/api/2020-10/collects/{collect_id}.json operations: - name: getcollectsparamcollectid method: GET description: Shopify Retrieves A Specific Collect By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collect_id in: path type: string description: collect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-countries.json path: /admin/api/2020-10/countries.json operations: - name: getcountries method: GET description: Shopify Retrieves A List Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-countries-count.json path: /admin/api/2020-10/countries/count.json operations: - name: getcountriescount method: GET description: Shopify Retrieves A Count Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-10-countries-country_id}.json path: /admin/api/2020-10/countries/{country_id}.json operations: - name: getcountriesparamcountryid method: GET description: Shopify Retrieves A Specific County outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-countries-country_id-provinces.json path: /admin/api/2020-10/countries/{country_id}/provinces.json operations: - name: getcountriesparamcountryidprovinces method: GET description: Shopify Retrieves A List Of Provinces outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of fields names. - name: admin-api-2020-10-countries-country_id-provinces-count.json path: /admin/api/2020-10/countries/{country_id}/provinces/count.json operations: - name: getcountriesparamcountryidprovincescount method: GET description: Shopify Retrieves A Count Of Provinces For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: admin-api-2020-10-countries-country_id-provinces-province_id}.json path: /admin/api/2020-10/countries/{country_id}/provinces/{province_id}.json operations: - name: getcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-currencies.json path: /admin/api/2020-10/currencies.json operations: - name: getcurrencies method: GET description: Shopify Retrieves A List Of Currencies Enabled On A Shop outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-10-custom_collections.json path: /admin/api/2020-10/custom_collections.json operations: - name: getcustomcollections method: GET description: Shopify Retrieves A List Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: ids in: query type: string description: Show only collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show custom collections with a given title. - name: product_id in: query type: string description: Show custom collections that include a given product. - name: handle in: query type: string description: Filter by custom collection handle. - name: updated_at_min in: query type: string description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Show custom collectsion with a given published status. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-custom_collections-count.json path: /admin/api/2020-10/custom_collections/count.json operations: - name: getcustomcollectionscount method: GET description: Shopify Retrieves A Count Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Count custom collections with given title. - name: product_id in: query type: string description: Count custom collections that include a given product. - name: updated_at_min in: query type: string description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count custom collections with a given published status. - name: admin-api-2020-10-custom_collections-custom_collection_id}.json path: /admin/api/2020-10/custom_collections/{custom_collection_id}.json operations: - name: getcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-customer_saved_searches.json path: /admin/api/2020-10/customer_saved_searches.json operations: - name: getcustomersavedsearches method: GET description: Shopify Retrieves A List Of Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-customer_saved_searches-count.json path: /admin/api/2020-10/customer_saved_searches/count.json operations: - name: getcustomersavedsearchescount method: GET description: Shopify Retrieves A Count Of All Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID - name: admin-api-2020-10-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json operations: - name: getcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-customer_saved_searches-customer_saved_search_id-customers.jso path: /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}/customers.json operations: - name: getcustomersavedsearchesparamcustomersavedsearchidcustomers method: GET description: Shopify Retrieves All Customers Returned By A Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: order in: query type: string description: Set the field and direction by which to order results. - name: limit in: query type: string description: The maximum number of results to show. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-customers-customer_id-addresses.json path: /admin/api/2020-10/customers/{customer_id}/addresses.json operations: - name: getcustomersparamcustomeridaddresses method: GET description: Shopify Retrieves A List Of Addresses For A Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: admin-api-2020-10-customers-customer_id-addresses-address_id}.json path: /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json operations: - name: getcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-2020-10-discount_codes-lookup.json path: /admin/api/2020-10/discount_codes/lookup.json operations: - name: getdiscountcodeslookup method: GET description: Shopify Retrieves The Location Of A Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: code in: query type: integer description: code - name: admin-api-2020-10-events.json path: /admin/api/2020-10/events.json operations: - name: getevents method: GET description: Shopify Retrieves A List Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: since_id in: query type: string description: Show only results after the specified ID. - name: created_at_min in: query type: string description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: filter in: query type: string description: Show events specified in this filter. - name: verb in: query type: string description: Show events of a certain type. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-events-count.json path: /admin/api/2020-10/events/count.json operations: - name: geteventscount method: GET description: Shopify Retrieves A Count Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created_at_min in: query type: string description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: admin-api-2020-10-events-event_id}.json path: /admin/api/2020-10/events/{event_id}.json operations: - name: geteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-fulfillment_orders-fulfillment_order_id}.json path: /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}.json operations: - name: getfulfillmentordersparamfulfillmentorderid method: GET description: Shopify Retrieves A Specific Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: admin-api-2020-10-fulfillment_orders-fulfillment_order_id-fulfillments.json path: /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillments.json operations: - name: getfulfillmentordersparamfulfillmentorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order that is associated with the fulfillments. - name: admin-api-2020-10-fulfillment_orders-fulfillment_order_id-locations_for_move.jso path: /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json operations: - name: getfulfillmentordersparamfulfillmentorderidlocationsformove method: GET description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order. - name: admin-api-2020-10-gift_cards.json path: /admin/api/2020-10/gift_cards.json operations: - name: getgiftcards method: GET description: Shopify Retrieves A List Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Retrieve gift cards with a given status. Valid values:' - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-gift_cards-count.json path: /admin/api/2020-10/gift_cards/count.json operations: - name: getgiftcardscount method: GET description: Shopify Retrieves A Count Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Count gift cards with a given status. Valid values:' - name: admin-api-2020-10-gift_cards-gift_card_id}.json path: /admin/api/2020-10/gift_cards/{gift_card_id}.json operations: - name: getgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-2020-10-inventory_items.json path: /admin/api/2020-10/inventory_items.json operations: - name: getinventoryitems method: GET description: Shopify Retrieves A List Of Inventory Items outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "ids\n required" in: query type: string description: Show only inventory items specified by a comma-separated list of IDs. - name: limit in: query type: string description: The maximum number of results to show. - name: ids in: query type: integer description: ids - name: admin-api-2020-10-inventory_items-inventory_item_id}.json path: /admin/api/2020-10/inventory_items/{inventory_item_id}.json operations: - name: getinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-2020-10-inventory_levels.json path: /admin/api/2020-10/inventory_levels.json operations: - name: getinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_ids in: query type: string description: A comma-separated list of inventory item IDs. - name: location_ids in: query type: string description: A comma-separated list of location IDs. To find the ID of a location, use the Location resource. - name: limit in: query type: string description: The maximum number of results to show. - name: updated_at_min in: query type: string description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' - name: admin-api-2020-10-locations.json path: /admin/api/2020-10/locations.json operations: - name: getlocations method: GET description: Shopify Retrieves A List Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-10-locations-count.json path: /admin/api/2020-10/locations/count.json operations: - name: getlocationscount method: GET description: Shopify Retrieves A Count Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-10-locations-location_id}.json path: /admin/api/2020-10/locations/{location_id}.json operations: - name: getlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-10-locations-location_id-inventory_levels.json path: /admin/api/2020-10/locations/{location_id}/inventory_levels.json operations: - name: getlocationsparamlocationidinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels For A Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-10-metafields.json path: /admin/api/2020-10/metafields.json operations: - name: getmetafields method: GET description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield[owner_id] in: query type: integer description: metafield[owner_id] - name: metafield[owner_resource] in: query type: string description: metafield[owner_resource] - name: admin-api-2020-10-metafields-count.json path: /admin/api/2020-10/metafields/count.json operations: - name: getmetafieldscount method: GET description: Shopify Retrieves A Count Of A Resource's Metafields outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-10-metafields-metafield_id}.json path: /admin/api/2020-10/metafields/{metafield_id}.json operations: - name: getmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-orders-order_id-fulfillment_orders.json path: /admin/api/2020-10/orders/{order_id}/fulfillment_orders.json operations: - name: getordersparamorderidfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: order_id in: query type: string description: The ID of the order that is associated with the fulfillment orders. - name: admin-api-2020-10-orders-order_id-fulfillments.json path: /admin/api/2020-10/orders/{order_id}/fulfillments.json operations: - name: getordersparamorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_max in: query type: string description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: limit in: query type: string description: Limit the amount of results. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_max in: query type: string description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-10-orders-order_id-fulfillments-count.json path: /admin/api/2020-10/orders/{order_id}/fulfillments/count.json operations: - name: getordersparamorderidfulfillmentscount method: GET description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_min in: query type: string description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-10-orders-order_id-fulfillments-fulfillment_id}.json path: /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}.json operations: - name: getordersparamorderidfulfillmentsparamfulfillmentid method: GET description: Shopify Retrieve A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fields in: query type: string description: Comma-separated list of fields to include in the response. - name: admin-api-2020-10-orders-order_id-fulfillments-fulfillment_id-events.json path: /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events.json operations: - name: getordersparamorderidfulfillmentsparamfulfillmentidevents method: GET description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fulfillment_id in: query type: string description: The ID of the fulfillment that's associated with the fulfillment event. - name: order_id in: query type: string description: The ID of the order that's associated with the fulfillment event. - name: admin-api-2020-10-orders-order_id-fulfillments-fulfillment_id-events-event_id}.j path: /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json operations: - name: getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid method: GET description: Shopify Retrieves A Specific Fulfillment Event outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: event_id in: path type: string description: event_id required: true - name: event_id in: query type: string description: The ID of the fulfillment event. - name: admin-api-2020-10-orders-order_id-refunds.json path: /admin/api/2020-10/orders/{order_id}/refunds.json operations: - name: getordersparamorderidrefunds method: GET description: Shopify Retrieves A List Of Refunds For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-2020-10-orders-order_id-refunds-refund_id}.json path: /admin/api/2020-10/orders/{order_id}/refunds/{refund_id}.json operations: - name: getordersparamorderidrefundsparamrefundid method: GET description: Shopify Retrieves A Specific Refund outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: refund_id in: path type: string description: refund_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-2020-10-orders-order_id-risks.json path: /admin/api/2020-10/orders/{order_id}/risks.json operations: - name: getordersparamorderidrisks method: GET description: Shopify Retrieves A List Of All Order Risks For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: admin-api-2020-10-orders-order_id-risks-risk_id}.json path: /admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json operations: - name: getordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-2020-10-policies.json path: /admin/api/2020-10/policies.json operations: - name: getpolicies method: GET description: Shopify Retrieves A List Of The Shop's Policies outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-10-price_rules-price_rule_id-batch-batch_id}.json path: /admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}.json operations: - name: getpricerulesparampriceruleidbatchparambatchid method: GET description: Shopify Retrieves A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-2020-10-price_rules-price_rule_id-batch-batch_id-discount_codes.json path: /admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json operations: - name: getpricerulesparampriceruleidbatchparambatchiddiscountcodes method: GET description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-2020-10-price_rules-price_rule_id-discount_codes.json path: /admin/api/2020-10/price_rules/{price_rule_id}/discount_codes.json operations: - name: getpricerulesparampriceruleiddiscountcodes method: GET description: Shopify Retrieve A List Of Discount Codes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: admin-api-2020-10-price_rules-price_rule_id-discount_codes-discount_code_id}.jso path: /admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-2020-10-products.json path: /admin/api/2020-10/products.json operations: - name: getproducts method: GET description: Shopify Retrieves A List Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Return only products specified by a comma-separated list of product IDs. - name: limit in: query type: string description: Return up to this many results per page. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Filter results by product title. - name: vendor in: query type: string description: Filter results by product vendor. - name: handle in: query type: string description: Filter results by product handle. - name: product_type in: query type: string description: Filter results by product type. - name: status in: query type: string description: Return products by their status. - name: collection_id in: query type: string description: Filter results by product collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: presentment_currencies in: query type: string description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. - name: admin-api-2020-10-products-count.json path: /admin/api/2020-10/products/count.json operations: - name: getproductscount method: GET description: Shopify Retrieves A Count Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: vendor in: query type: string description: Filter results by product vendor. - name: product_type in: query type: string description: Filter results by product type. - name: collection_id in: query type: string description: Filter results by collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: admin-api-2020-10-products-product_id}.json path: /admin/api/2020-10/products/{product_id}.json operations: - name: getproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-10-redirects.json path: /admin/api/2020-10/redirects.json operations: - name: getredirects method: GET description: Shopify Retrieves A List Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: path in: query type: string description: Show redirects with a given path. - name: target in: query type: string description: Show redirects with a given target. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-redirects-count.json path: /admin/api/2020-10/redirects/count.json operations: - name: getredirectscount method: GET description: Shopify Retrieves A Count Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: path in: query type: string description: Count redirects with given path. - name: target in: query type: string description: Count redirects with given target. - name: admin-api-2020-10-redirects-redirect_id}.json path: /admin/api/2020-10/redirects/{redirect_id}.json operations: - name: getredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-script_tags.json path: /admin/api/2020-10/script_tags.json operations: - name: getscripttags method: GET description: Shopify Retrieves A List Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: src in: query type: string description: Show script tags with this URL. - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-10-script_tags-count.json path: /admin/api/2020-10/script_tags/count.json operations: - name: getscripttagscount method: GET description: Shopify Retrieves A Count Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: src in: query type: string description: Count only script tags with a given URL. - name: admin-api-2020-10-script_tags-script_tag_id}.json path: /admin/api/2020-10/script_tags/{script_tag_id}.json operations: - name: getscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-10-shop.json path: /admin/api/2020-10/shop.json operations: - name: getshop method: GET description: Shopify Retrieves The Shop's Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-10-shopify_payments-balance.json path: /admin/api/2020-10/shopify_payments/balance.json operations: - name: getshopifypaymentsbalance method: GET description: Shopify Retrieves The Account's Current Balance outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-10-shopify_payments-payouts.json path: /admin/api/2020-10/shopify_payments/payouts.json operations: - name: getshopifypaymentspayouts method: GET description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Filter the response to payouts made after the specified ID. - name: last_id in: query type: string description: Filter the response to payouts made before the specified ID. - name: date_min in: query type: string description: Filter the response to payouts made inclusively after the specified date. - name: date_max in: query type: string description: Filter the response to payouts made inclusively before the specified date. - name: date in: query type: string description: Filter the response to payouts made on the specified date. - name: status in: query type: string description: Filter the response to payouts made with the specified status. - name: admin-api-2020-10-shopify_payments-payouts-payout_id}.json path: /admin/api/2020-10/shopify_payments/payouts/{payout_id}.json operations: - name: getshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-2020-10-smart_collections.json path: /admin/api/2020-10/smart_collections.json operations: - name: getsmartcollections method: GET description: Shopify Retrieves A List Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: ids in: query type: string description: Show only the smart collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that includes the specified product. - name: handle in: query type: string description: Filter results by smart collection handle. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-smart_collections-count.json path: /admin/api/2020-10/smart_collections/count.json operations: - name: getsmartcollectionscount method: GET description: Shopify Retrieves A Count Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that include the specified product. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: admin-api-2020-10-smart_collections-smart_collection_id}.json path: /admin/api/2020-10/smart_collections/{smart_collection_id}.json operations: - name: getsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-tender_transactions.json path: /admin/api/2020-10/tender_transactions.json operations: - name: gettendertransactions method: GET description: Shopify Retrieves A List Of Tender Transactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Retrieve only transactions after the specified ID. - name: processed_at_min in: query type: string description: Show tender transactions processed_at or after the specified date. - name: processed_at_max in: query type: string description: Show tender transactions processed_at or before the specified date. - name: processed_at in: query type: string description: Show tender transactions processed at the specified date. - name: order in: query type: string description: Show tender transactions ordered by processed_at in ascending or descending order. - name: admin-api-2020-10-themes.json path: /admin/api/2020-10/themes.json operations: - name: getthemes method: GET description: Shopify Retrieves A List Of Themes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-themes-theme_id}.json path: /admin/api/2020-10/themes/{theme_id}.json operations: - name: getthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-themes-theme_id-assets.json path: /admin/api/2020-10/themes/{theme_id}/assets.json operations: - name: getthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-2020-10-users.json path: /admin/api/2020-10/users.json operations: - name: getusers method: GET description: Shopify Retrieves A List Of All Users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show on a page. - name: page_info in: query type: string description: A unique ID used to access a certain page of results. - name: admin-api-2020-10-users-current.json path: /admin/api/2020-10/users/current.json operations: - name: getuserscurrent method: GET description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2020-10-users-user_id}.json path: /admin/api/2020-10/users/{user_id}.json operations: - name: getusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-2020-10-webhooks.json path: /admin/api/2020-10/webhooks.json operations: - name: getwebhooks method: GET description: Shopify Retrieves A List Of Webhooks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: created_at_max in: query type: string description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: limit in: query type: string description: Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error. - name: since_id in: query type: string description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: updated_at_min in: query type: string description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2020-10-webhooks-count.json path: /admin/api/2020-10/webhooks/count.json operations: - name: getwebhookscount method: GET description: Shopify Retrieves A Count Of Existing Webhook Subscriptions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: admin-api-2020-10-webhooks-webhook_id}.json path: /admin/api/2020-10/webhooks/{webhook_id}.json operations: - name: getwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: admin-api-2021-01-articles-authors.json path: /admin/api/2021-01/articles/authors.json operations: - name: deprecated202101getarticlesauthors method: GET description: Shopify Retrieves A List All Of Article Authors outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-articles-tags.json path: /admin/api/2021-01/articles/tags.json operations: - name: deprecated202101getarticlestags method: GET description: Shopify Retrieves A List Of All The Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of tags to retrieve. - name: popular in: query type: string description: A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag. - name: admin-api-2021-01-assigned_fulfillment_orders.json path: /admin/api/2021-01/assigned_fulfillment_orders.json operations: - name: deprecated202101getassignedfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: assignment_status in: query type: string description: 'The assigment status of the fulfillment orders that should be returned:' - name: location_ids in: query type: string description: The IDs of the assigned locations of the fulfillment orders that should be returned. - name: location_ids[] in: query type: integer description: location_ids[] - name: admin-api-2021-01-blogs-blog_id-articles.json path: /admin/api/2021-01/blogs/{blog_id}/articles.json operations: - name: deprecated202101getblogsparamblogidarticles method: GET description: Shopify Retrieves A List Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Retrieve results based on their published status. - name: handle in: query type: string description: Retrieve an article with a specific handle. - name: tag in: query type: string description: Filter articles with a specific tag. - name: author in: query type: string description: Filter articles by article author. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-blogs-blog_id-articles-count.json path: /admin/api/2021-01/blogs/{blog_id}/articles/count.json operations: - name: deprecated202101getblogsparamblogidarticlescount method: GET description: Shopify Retrieves A Count Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: created_at_min in: query type: string description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count articles with a given published status. - name: admin-api-2021-01-blogs-blog_id-articles-article_id}.json path: /admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.json operations: - name: deprecated202101getblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-2021-01-carrier_services.json path: /admin/api/2021-01/carrier_services.json operations: - name: deprecated202101getcarrierservices method: GET description: Shopify Retrieves A List Of Carrier Services outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-carrier_services-carrier_service_id}.json path: /admin/api/2021-01/carrier_services/{carrier_service_id}.json operations: - name: deprecated202101getcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-2021-01-checkouts-count.json path: /admin/api/2021-01/checkouts/count.json operations: - name: deprecated202101getcheckoutscount method: GET description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: status in: query type: string description: Count checkouts with a given status. - name: admin-api-2021-01-checkouts-token}.json path: /admin/api/2021-01/checkouts/{token}.json operations: - name: deprecated202101getcheckoutsparamtoken method: GET description: Shopify Retrieves A Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2021-01-checkouts-token-payments.json path: /admin/api/2021-01/checkouts/{token}/payments.json operations: - name: deprecated202101getcheckoutsparamtokenpayments method: GET description: Shopify Retrieves A List Of Payments On A Particular Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2021-01-checkouts-token-payments-payment_id}.json path: /admin/api/2021-01/checkouts/{token}/payments/{payment_id}.json operations: - name: deprecated202101getcheckoutsparamtokenpaymentsparampaymentid method: GET description: Shopify Retrieves The Payment Information For An Existing Payment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: payment_id in: path type: string description: payment_id required: true - name: admin-api-2021-01-checkouts-token-shipping_rates.json path: /admin/api/2021-01/checkouts/{token}/shipping_rates.json operations: - name: deprecated202101getcheckoutsparamtokenshippingrates method: GET description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-2021-01-collection_listings.json path: /admin/api/2021-01/collection_listings.json operations: - name: deprecated202101getcollectionlistings method: GET description: Shopify Retrieve Collection Listings That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: Amount of results - name: admin-api-2021-01-collection_listings-collection_listing_id}.json path: /admin/api/2021-01/collection_listings/{collection_listing_id}.json operations: - name: deprecated202101getcollectionlistingsparamcollectionlistingid method: GET description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: admin-api-2021-01-collection_listings-collection_listing_id-product_ids.json path: /admin/api/2021-01/collection_listings/{collection_listing_id}/product_ids.json operations: - name: deprecated202101getcollectionlistingsparamcollectionlistingidproductids method: GET description: Shopify Retrieve Product_ids That Are Published To A Collection_id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: limit in: query type: string description: Amount of results - name: admin-api-2021-01-collections-collection_id}.json path: /admin/api/2021-01/collections/{collection_id}.json operations: - name: deprecated202101getcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-collections-collection_id-products.json path: /admin/api/2021-01/collections/{collection_id}/products.json operations: - name: deprecated202101getcollectionsparamcollectionidproducts method: GET description: Shopify Retrieve A List Of Products Belonging To A Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: limit in: query type: string description: The number of products to retrieve. - name: admin-api-2021-01-collects.json path: /admin/api/2021-01/collects.json operations: - name: deprecated202101getcollects method: GET description: Shopify Retrieves A List Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-collects-count.json path: /admin/api/2021-01/collects/count.json operations: - name: deprecated202101getcollectscount method: GET description: Shopify Retrieves A Count Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: query type: integer description: collection_id - name: admin-api-2021-01-collects-collect_id}.json path: /admin/api/2021-01/collects/{collect_id}.json operations: - name: deprecated202101getcollectsparamcollectid method: GET description: Shopify Retrieves A Specific Collect By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collect_id in: path type: string description: collect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-countries.json path: /admin/api/2021-01/countries.json operations: - name: deprecated202101getcountries method: GET description: Shopify Retrieves A List Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-countries-count.json path: /admin/api/2021-01/countries/count.json operations: - name: deprecated202101getcountriescount method: GET description: Shopify Retrieves A Count Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-countries-country_id}.json path: /admin/api/2021-01/countries/{country_id}.json operations: - name: deprecated202101getcountriesparamcountryid method: GET description: Shopify Retrieves A Specific County outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-countries-country_id-provinces.json path: /admin/api/2021-01/countries/{country_id}/provinces.json operations: - name: deprecated202101getcountriesparamcountryidprovinces method: GET description: Shopify Retrieves A List Of Provinces outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of fields names. - name: admin-api-2021-01-countries-country_id-provinces-count.json path: /admin/api/2021-01/countries/{country_id}/provinces/count.json operations: - name: deprecated202101getcountriesparamcountryidprovincescount method: GET description: Shopify Retrieves A Count Of Provinces For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: admin-api-2021-01-countries-country_id-provinces-province_id}.json path: /admin/api/2021-01/countries/{country_id}/provinces/{province_id}.json operations: - name: deprecated202101getcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-currencies.json path: /admin/api/2021-01/currencies.json operations: - name: deprecated202101getcurrencies method: GET description: Shopify Retrieves A List Of Currencies Enabled On A Shop outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-custom_collections.json path: /admin/api/2021-01/custom_collections.json operations: - name: deprecated202101getcustomcollections method: GET description: Shopify Retrieves A List Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: ids in: query type: string description: Show only collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show custom collections with a given title. - name: product_id in: query type: string description: Show custom collections that include a given product. - name: handle in: query type: string description: Filter by custom collection handle. - name: updated_at_min in: query type: string description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Show custom collectsion with a given published status. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-custom_collections-count.json path: /admin/api/2021-01/custom_collections/count.json operations: - name: deprecated202101getcustomcollectionscount method: GET description: Shopify Retrieves A Count Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Count custom collections with given title. - name: product_id in: query type: string description: Count custom collections that include a given product. - name: updated_at_min in: query type: string description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count custom collections with a given published status. - name: admin-api-2021-01-custom_collections-custom_collection_id}.json path: /admin/api/2021-01/custom_collections/{custom_collection_id}.json operations: - name: deprecated202101getcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-customer_saved_searches.json path: /admin/api/2021-01/customer_saved_searches.json operations: - name: deprecated202101getcustomersavedsearches method: GET description: Shopify Retrieves A List Of Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-customer_saved_searches-count.json path: /admin/api/2021-01/customer_saved_searches/count.json operations: - name: deprecated202101getcustomersavedsearchescount method: GET description: Shopify Retrieves A Count Of All Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID - name: admin-api-2021-01-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json operations: - name: deprecated202101getcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-customer_saved_searches-customer_saved_search_id-customers.jso path: /admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}/customers.json operations: - name: deprecated202101getcustomersavedsearchesparamcustomersavedsearchidcustomers method: GET description: Shopify Retrieves All Customers Returned By A Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: order in: query type: string description: Set the field and direction by which to order results. - name: limit in: query type: string description: The maximum number of results to show. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-customers-customer_id-addresses.json path: /admin/api/2021-01/customers/{customer_id}/addresses.json operations: - name: deprecated202101getcustomersparamcustomeridaddresses method: GET description: Shopify Retrieves A List Of Addresses For A Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: admin-api-2021-01-customers-customer_id-addresses-address_id}.json path: /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json operations: - name: deprecated202101getcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-2021-01-deprecated_api_calls.json path: /admin/api/2021-01/deprecated_api_calls.json operations: - name: deprecated202101getdeprecatedapicalls method: GET description: Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-discount_codes-lookup.json path: /admin/api/2021-01/discount_codes/lookup.json operations: - name: deprecated202101getdiscountcodeslookup method: GET description: Shopify Retrieves The Location Of A Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: code in: query type: integer description: code - name: admin-api-2021-01-events.json path: /admin/api/2021-01/events.json operations: - name: deprecated202101getevents method: GET description: Shopify Retrieves A List Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: since_id in: query type: string description: Show only results after the specified ID. - name: created_at_min in: query type: string description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: filter in: query type: string description: Show events specified in this filter. - name: verb in: query type: string description: Show events of a certain type. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-events-count.json path: /admin/api/2021-01/events/count.json operations: - name: deprecated202101geteventscount method: GET description: Shopify Retrieves A Count Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created_at_min in: query type: string description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: admin-api-2021-01-events-event_id}.json path: /admin/api/2021-01/events/{event_id}.json operations: - name: deprecated202101geteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-fulfillment_orders-fulfillment_order_id}.json path: /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}.json operations: - name: deprecated202101getfulfillmentordersparamfulfillmentorderid method: GET description: Shopify Retrieves A Specific Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: admin-api-2021-01-fulfillment_orders-fulfillment_order_id-fulfillments.json path: /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json operations: - name: deprecated202101getfulfillmentordersparamfulfillmentorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order that is associated with the fulfillments. - name: admin-api-2021-01-fulfillment_orders-fulfillment_order_id-locations_for_move.jso path: /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json operations: - name: deprecated202101getfulfillmentordersparamfulfillmentorderidlocationsformove method: GET description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order. - name: admin-api-2021-01-gift_cards.json path: /admin/api/2021-01/gift_cards.json operations: - name: deprecated202101getgiftcards method: GET description: Shopify Retrieves A List Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Retrieve gift cards with a given status. Valid values:' - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-gift_cards-count.json path: /admin/api/2021-01/gift_cards/count.json operations: - name: deprecated202101getgiftcardscount method: GET description: Shopify Retrieves A Count Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Count gift cards with a given status. Valid values:' - name: admin-api-2021-01-gift_cards-gift_card_id}.json path: /admin/api/2021-01/gift_cards/{gift_card_id}.json operations: - name: deprecated202101getgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-2021-01-inventory_items.json path: /admin/api/2021-01/inventory_items.json operations: - name: deprecated202101getinventoryitems method: GET description: Shopify Retrieves A List Of Inventory Items outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "ids\n required" in: query type: string description: Show only inventory items specified by a comma-separated list of IDs. - name: limit in: query type: string description: The maximum number of results to show. - name: ids in: query type: integer description: ids - name: admin-api-2021-01-inventory_items-inventory_item_id}.json path: /admin/api/2021-01/inventory_items/{inventory_item_id}.json operations: - name: deprecated202101getinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-2021-01-inventory_levels.json path: /admin/api/2021-01/inventory_levels.json operations: - name: deprecated202101getinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_ids in: query type: string description: A comma-separated list of inventory item IDs. - name: location_ids in: query type: string description: A comma-separated list of location IDs. To find the ID of a location, use the Location resource. - name: limit in: query type: string description: The maximum number of results to show. - name: updated_at_min in: query type: string description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' - name: admin-api-2021-01-locations.json path: /admin/api/2021-01/locations.json operations: - name: deprecated202101getlocations method: GET description: Shopify Retrieves A List Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-locations-count.json path: /admin/api/2021-01/locations/count.json operations: - name: deprecated202101getlocationscount method: GET description: Shopify Retrieves A Count Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-locations-location_id}.json path: /admin/api/2021-01/locations/{location_id}.json operations: - name: deprecated202101getlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2021-01-locations-location_id-inventory_levels.json path: /admin/api/2021-01/locations/{location_id}/inventory_levels.json operations: - name: deprecated202101getlocationsparamlocationidinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels For A Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2021-01-metafields.json path: /admin/api/2021-01/metafields.json operations: - name: deprecated202101getmetafields method: GET description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield[owner_id] in: query type: integer description: metafield[owner_id] - name: metafield[owner_resource] in: query type: string description: metafield[owner_resource] - name: admin-api-2021-01-metafields-count.json path: /admin/api/2021-01/metafields/count.json operations: - name: deprecated202101getmetafieldscount method: GET description: Shopify Retrieves A Count Of A Resource's Metafields outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-metafields-metafield_id}.json path: /admin/api/2021-01/metafields/{metafield_id}.json operations: - name: deprecated202101getmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-orders-order_id-fulfillment_orders.json path: /admin/api/2021-01/orders/{order_id}/fulfillment_orders.json operations: - name: deprecated202101getordersparamorderidfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: order_id in: query type: string description: The ID of the order that is associated with the fulfillment orders. - name: admin-api-2021-01-orders-order_id-fulfillments.json path: /admin/api/2021-01/orders/{order_id}/fulfillments.json operations: - name: deprecated202101getordersparamorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_max in: query type: string description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: limit in: query type: string description: Limit the amount of results. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_max in: query type: string description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2021-01-orders-order_id-fulfillments-count.json path: /admin/api/2021-01/orders/{order_id}/fulfillments/count.json operations: - name: deprecated202101getordersparamorderidfulfillmentscount method: GET description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_min in: query type: string description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2021-01-orders-order_id-fulfillments-fulfillment_id}.json path: /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}.json operations: - name: deprecated202101getordersparamorderidfulfillmentsparamfulfillmentid method: GET description: Shopify Retrieve A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fields in: query type: string description: Comma-separated list of fields to include in the response. - name: admin-api-2021-01-orders-order_id-fulfillments-fulfillment_id-events.json path: /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json operations: - name: deprecated202101getordersparamorderidfulfillmentsparamfulfillmentidevents method: GET description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fulfillment_id in: query type: string description: The ID of the fulfillment that's associated with the fulfillment event. - name: order_id in: query type: string description: The ID of the order that's associated with the fulfillment event. - name: admin-api-2021-01-orders-order_id-fulfillments-fulfillment_id-events-event_id}.j path: /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json operations: - name: deprecated202101getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid method: GET description: Shopify Retrieves A Specific Fulfillment Event outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: event_id in: path type: string description: event_id required: true - name: event_id in: query type: string description: The ID of the fulfillment event. - name: admin-api-2021-01-orders-order_id-refunds.json path: /admin/api/2021-01/orders/{order_id}/refunds.json operations: - name: deprecated202101getordersparamorderidrefunds method: GET description: Shopify Retrieves A List Of Refunds For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-2021-01-orders-order_id-refunds-refund_id}.json path: /admin/api/2021-01/orders/{order_id}/refunds/{refund_id}.json operations: - name: deprecated202101getordersparamorderidrefundsparamrefundid method: GET description: Shopify Retrieves A Specific Refund outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: refund_id in: path type: string description: refund_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-2021-01-orders-order_id-risks.json path: /admin/api/2021-01/orders/{order_id}/risks.json operations: - name: deprecated202101getordersparamorderidrisks method: GET description: Shopify Retrieves A List Of All Order Risks For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: admin-api-2021-01-orders-order_id-risks-risk_id}.json path: /admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json operations: - name: deprecated202101getordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-2021-01-policies.json path: /admin/api/2021-01/policies.json operations: - name: deprecated202101getpolicies method: GET description: Shopify Retrieves A List Of The Shop's Policies outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-price_rules-price_rule_id-batch-batch_id}.json path: /admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}.json operations: - name: deprecated202101getpricerulesparampriceruleidbatchparambatchid method: GET description: Shopify Retrieves A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-2021-01-price_rules-price_rule_id-batch-batch_id-discount_codes.json path: /admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json operations: - name: deprecated202101getpricerulesparampriceruleidbatchparambatchiddiscountcodes method: GET description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-2021-01-price_rules-price_rule_id-discount_codes.json path: /admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.json operations: - name: deprecated202101getpricerulesparampriceruleiddiscountcodes method: GET description: Shopify Retrieve A List Of Discount Codes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: admin-api-2021-01-price_rules-price_rule_id-discount_codes-discount_code_id}.jso path: /admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: deprecated202101getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-2021-01-products.json path: /admin/api/2021-01/products.json operations: - name: deprecated202101getproducts method: GET description: Shopify Retrieves A List Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Return only products specified by a comma-separated list of product IDs. - name: limit in: query type: string description: Return up to this many results per page. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Filter results by product title. - name: vendor in: query type: string description: Filter results by product vendor. - name: handle in: query type: string description: Filter results by product handle. - name: product_type in: query type: string description: Filter results by product type. - name: status in: query type: string description: Return products by their status. - name: collection_id in: query type: string description: Filter results by product collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: presentment_currencies in: query type: string description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. - name: admin-api-2021-01-products-count.json path: /admin/api/2021-01/products/count.json operations: - name: deprecated202101getproductscount method: GET description: Shopify Retrieves A Count Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: vendor in: query type: string description: Filter results by product vendor. - name: product_type in: query type: string description: Filter results by product type. - name: collection_id in: query type: string description: Filter results by collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: admin-api-2021-01-products-product_id}.json path: /admin/api/2021-01/products/{product_id}.json operations: - name: deprecated202101getproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2021-01-redirects.json path: /admin/api/2021-01/redirects.json operations: - name: deprecated202101getredirects method: GET description: Shopify Retrieves A List Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: path in: query type: string description: Show redirects with a given path. - name: target in: query type: string description: Show redirects with a given target. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-redirects-count.json path: /admin/api/2021-01/redirects/count.json operations: - name: deprecated202101getredirectscount method: GET description: Shopify Retrieves A Count Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: path in: query type: string description: Count redirects with given path. - name: target in: query type: string description: Count redirects with given target. - name: admin-api-2021-01-redirects-redirect_id}.json path: /admin/api/2021-01/redirects/{redirect_id}.json operations: - name: deprecated202101getredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-script_tags.json path: /admin/api/2021-01/script_tags.json operations: - name: deprecated202101getscripttags method: GET description: Shopify Retrieves A List Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: src in: query type: string description: Show script tags with this URL. - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2021-01-script_tags-count.json path: /admin/api/2021-01/script_tags/count.json operations: - name: deprecated202101getscripttagscount method: GET description: Shopify Retrieves A Count Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: src in: query type: string description: Count only script tags with a given URL. - name: admin-api-2021-01-script_tags-script_tag_id}.json path: /admin/api/2021-01/script_tags/{script_tag_id}.json operations: - name: deprecated202101getscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2021-01-shop.json path: /admin/api/2021-01/shop.json operations: - name: deprecated202101getshop method: GET description: Shopify Retrieves The Shop's Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2021-01-shopify_payments-balance.json path: /admin/api/2021-01/shopify_payments/balance.json operations: - name: deprecated202101getshopifypaymentsbalance method: GET description: Shopify Retrieves The Account's Current Balance outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-shopify_payments-payouts.json path: /admin/api/2021-01/shopify_payments/payouts.json operations: - name: deprecated202101getshopifypaymentspayouts method: GET description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Filter the response to payouts made after the specified ID. - name: last_id in: query type: string description: Filter the response to payouts made before the specified ID. - name: date_min in: query type: string description: Filter the response to payouts made inclusively after the specified date. - name: date_max in: query type: string description: Filter the response to payouts made inclusively before the specified date. - name: date in: query type: string description: Filter the response to payouts made on the specified date. - name: status in: query type: string description: Filter the response to payouts made with the specified status. - name: admin-api-2021-01-shopify_payments-payouts-payout_id}.json path: /admin/api/2021-01/shopify_payments/payouts/{payout_id}.json operations: - name: deprecated202101getshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-2021-01-smart_collections.json path: /admin/api/2021-01/smart_collections.json operations: - name: deprecated202101getsmartcollections method: GET description: Shopify Retrieves A List Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: ids in: query type: string description: Show only the smart collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that includes the specified product. - name: handle in: query type: string description: Filter results by smart collection handle. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-smart_collections-count.json path: /admin/api/2021-01/smart_collections/count.json operations: - name: deprecated202101getsmartcollectionscount method: GET description: Shopify Retrieves A Count Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that include the specified product. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: admin-api-2021-01-smart_collections-smart_collection_id}.json path: /admin/api/2021-01/smart_collections/{smart_collection_id}.json operations: - name: deprecated202101getsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-tender_transactions.json path: /admin/api/2021-01/tender_transactions.json operations: - name: deprecated202101gettendertransactions method: GET description: Shopify Retrieves A List Of Tender Transactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Retrieve only transactions after the specified ID. - name: processed_at_min in: query type: string description: Show tender transactions processed_at or after the specified date. - name: processed_at_max in: query type: string description: Show tender transactions processed_at or before the specified date. - name: processed_at in: query type: string description: Show tender transactions processed at the specified date. - name: order in: query type: string description: Show tender transactions ordered by processed_at in ascending or descending order. - name: admin-api-2021-01-themes.json path: /admin/api/2021-01/themes.json operations: - name: deprecated202101getthemes method: GET description: Shopify Retrieves A List Of Themes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-themes-theme_id}.json path: /admin/api/2021-01/themes/{theme_id}.json operations: - name: deprecated202101getthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-themes-theme_id-assets.json path: /admin/api/2021-01/themes/{theme_id}/assets.json operations: - name: deprecated202101getthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-2021-01-users.json path: /admin/api/2021-01/users.json operations: - name: deprecated202101getusers method: GET description: Shopify Retrieves A List Of All Users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show on a page. - name: page_info in: query type: string description: A unique ID used to access a certain page of results. - name: admin-api-2021-01-users-current.json path: /admin/api/2021-01/users/current.json operations: - name: deprecated202101getuserscurrent method: GET description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-2021-01-users-user_id}.json path: /admin/api/2021-01/users/{user_id}.json operations: - name: deprecated202101getusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-2021-01-webhooks.json path: /admin/api/2021-01/webhooks.json operations: - name: deprecated202101getwebhooks method: GET description: Shopify Retrieves A List Of Webhooks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: created_at_max in: query type: string description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: limit in: query type: string description: Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error. - name: since_id in: query type: string description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: updated_at_min in: query type: string description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-2021-01-webhooks-count.json path: /admin/api/2021-01/webhooks/count.json operations: - name: deprecated202101getwebhookscount method: GET description: Shopify Retrieves A Count Of Existing Webhook Subscriptions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: admin-api-2021-01-webhooks-webhook_id}.json path: /admin/api/2021-01/webhooks/{webhook_id}.json operations: - name: deprecated202101getwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: admin-api-unstable-articles-authors.json path: /admin/api/unstable/articles/authors.json operations: - name: deprecatedunstablegetarticlesauthors method: GET description: Shopify Retrieves A List All Of Article Authors outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-articles-tags.json path: /admin/api/unstable/articles/tags.json operations: - name: deprecatedunstablegetarticlestags method: GET description: Shopify Retrieves A List Of All The Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of tags to retrieve. - name: popular in: query type: string description: A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag. - name: admin-api-unstable-assigned_fulfillment_orders.json path: /admin/api/unstable/assigned_fulfillment_orders.json operations: - name: deprecatedunstablegetassignedfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: assignment_status in: query type: string description: 'The assigment status of the fulfillment orders that should be returned:' - name: location_ids in: query type: string description: The IDs of the assigned locations of the fulfillment orders that should be returned. - name: location_ids[] in: query type: integer description: location_ids[] - name: admin-api-unstable-blogs-blog_id-articles.json path: /admin/api/unstable/blogs/{blog_id}/articles.json operations: - name: deprecatedunstablegetblogsparamblogidarticles method: GET description: Shopify Retrieves A List Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Retrieve results based on their published status. - name: handle in: query type: string description: Retrieve an article with a specific handle. - name: tag in: query type: string description: Filter articles with a specific tag. - name: author in: query type: string description: Filter articles by article author. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-blogs-blog_id-articles-count.json path: /admin/api/unstable/blogs/{blog_id}/articles/count.json operations: - name: deprecatedunstablegetblogsparamblogidarticlescount method: GET description: Shopify Retrieves A Count Of All Articles From A Blog outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: created_at_min in: query type: string description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count articles with a given published status. - name: admin-api-unstable-blogs-blog_id-articles-article_id}.json path: /admin/api/unstable/blogs/{blog_id}/articles/{article_id}.json operations: - name: deprecatedunstablegetblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-unstable-carrier_services.json path: /admin/api/unstable/carrier_services.json operations: - name: deprecatedunstablegetcarrierservices method: GET description: Shopify Retrieves A List Of Carrier Services outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-carrier_services-carrier_service_id}.json path: /admin/api/unstable/carrier_services/{carrier_service_id}.json operations: - name: deprecatedunstablegetcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-unstable-checkouts-count.json path: /admin/api/unstable/checkouts/count.json operations: - name: deprecatedunstablegetcheckoutscount method: GET description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' - name: status in: query type: string description: Count checkouts with a given status. - name: admin-api-unstable-checkouts-token}.json path: /admin/api/unstable/checkouts/{token}.json operations: - name: deprecatedunstablegetcheckoutsparamtoken method: GET description: Shopify Retrieves A Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-unstable-checkouts-token-payments.json path: /admin/api/unstable/checkouts/{token}/payments.json operations: - name: deprecatedunstablegetcheckoutsparamtokenpayments method: GET description: Shopify Retrieves A List Of Payments On A Particular Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-unstable-checkouts-token-payments-payment_id}.json path: /admin/api/unstable/checkouts/{token}/payments/{payment_id}.json operations: - name: deprecatedunstablegetcheckoutsparamtokenpaymentsparampaymentid method: GET description: Shopify Retrieves The Payment Information For An Existing Payment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: payment_id in: path type: string description: payment_id required: true - name: admin-api-unstable-checkouts-token-shipping_rates.json path: /admin/api/unstable/checkouts/{token}/shipping_rates.json operations: - name: deprecatedunstablegetcheckoutsparamtokenshippingrates method: GET description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: token in: path type: string description: token required: true - name: admin-api-unstable-collection_listings.json path: /admin/api/unstable/collection_listings.json operations: - name: deprecatedunstablegetcollectionlistings method: GET description: Shopify Retrieve Collection Listings That Are Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: Amount of results - name: admin-api-unstable-collection_listings-collection_listing_id}.json path: /admin/api/unstable/collection_listings/{collection_listing_id}.json operations: - name: deprecatedunstablegetcollectionlistingsparamcollectionlistingid method: GET description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: admin-api-unstable-collection_listings-collection_listing_id-product_ids.json path: /admin/api/unstable/collection_listings/{collection_listing_id}/product_ids.json operations: - name: deprecatedunstablegetcollectionlistingsparamcollectionlistingidproductids method: GET description: Shopify Retrieve Product_ids That Are Published To A Collection_id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_listing_id in: path type: string description: collection_listing_id required: true - name: limit in: query type: string description: Amount of results - name: admin-api-unstable-collections-collection_id}.json path: /admin/api/unstable/collections/{collection_id}.json operations: - name: deprecatedunstablegetcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-collections-collection_id-products.json path: /admin/api/unstable/collections/{collection_id}/products.json operations: - name: deprecatedunstablegetcollectionsparamcollectionidproducts method: GET description: Shopify Retrieve A List Of Products Belonging To A Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: limit in: query type: string description: The number of products to retrieve. - name: admin-api-unstable-collects.json path: /admin/api/unstable/collects.json operations: - name: deprecatedunstablegetcollects method: GET description: Shopify Retrieves A List Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-collects-count.json path: /admin/api/unstable/collects/count.json operations: - name: deprecatedunstablegetcollectscount method: GET description: Shopify Retrieves A Count Of Collects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: query type: integer description: collection_id - name: admin-api-unstable-collects-collect_id}.json path: /admin/api/unstable/collects/{collect_id}.json operations: - name: deprecatedunstablegetcollectsparamcollectid method: GET description: Shopify Retrieves A Specific Collect By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collect_id in: path type: string description: collect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-countries.json path: /admin/api/unstable/countries.json operations: - name: deprecatedunstablegetcountries method: GET description: Shopify Retrieves A List Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-countries-count.json path: /admin/api/unstable/countries/count.json operations: - name: deprecatedunstablegetcountriescount method: GET description: Shopify Retrieves A Count Of Countries outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-countries-country_id}.json path: /admin/api/unstable/countries/{country_id}.json operations: - name: deprecatedunstablegetcountriesparamcountryid method: GET description: Shopify Retrieves A Specific County outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-countries-country_id-provinces.json path: /admin/api/unstable/countries/{country_id}/provinces.json operations: - name: deprecatedunstablegetcountriesparamcountryidprovinces method: GET description: Shopify Retrieves A List Of Provinces outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of fields names. - name: admin-api-unstable-countries-country_id-provinces-count.json path: /admin/api/unstable/countries/{country_id}/provinces/count.json operations: - name: deprecatedunstablegetcountriesparamcountryidprovincescount method: GET description: Shopify Retrieves A Count Of Provinces For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: admin-api-unstable-countries-country_id-provinces-province_id}.json path: /admin/api/unstable/countries/{country_id}/provinces/{province_id}.json operations: - name: deprecatedunstablegetcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-currencies.json path: /admin/api/unstable/currencies.json operations: - name: deprecatedunstablegetcurrencies method: GET description: Shopify Retrieves A List Of Currencies Enabled On A Shop outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-custom_collections.json path: /admin/api/unstable/custom_collections.json operations: - name: deprecatedunstablegetcustomcollections method: GET description: Shopify Retrieves A List Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: ids in: query type: string description: Show only collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show custom collections with a given title. - name: product_id in: query type: string description: Show custom collections that include a given product. - name: handle in: query type: string description: Filter by custom collection handle. - name: updated_at_min in: query type: string description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Show custom collectsion with a given published status. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-custom_collections-count.json path: /admin/api/unstable/custom_collections/count.json operations: - name: deprecatedunstablegetcustomcollectionscount method: GET description: Shopify Retrieves A Count Of Custom Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Count custom collections with given title. - name: product_id in: query type: string description: Count custom collections that include a given product. - name: updated_at_min in: query type: string description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_min in: query type: string description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' - name: published_at_max in: query type: string description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' - name: published_status in: query type: string description: Count custom collections with a given published status. - name: admin-api-unstable-custom_collections-custom_collection_id}.json path: /admin/api/unstable/custom_collections/{custom_collection_id}.json operations: - name: deprecatedunstablegetcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-customer_saved_searches.json path: /admin/api/unstable/customer_saved_searches.json operations: - name: deprecatedunstablegetcustomersavedsearches method: GET description: Shopify Retrieves A List Of Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-customer_saved_searches-count.json path: /admin/api/unstable/customer_saved_searches/count.json operations: - name: deprecatedunstablegetcustomersavedsearchescount method: GET description: Shopify Retrieves A Count Of All Customer Saved Searches outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Restrict results to after the specified ID - name: admin-api-unstable-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.json operations: - name: deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-customer_saved_searches-customer_saved_search_id-customers.js path: /admin/api/unstable/customer_saved_searches/{customer_saved_search_id}/customers.json operations: - name: deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchidcustomers method: GET description: Shopify Retrieves All Customers Returned By A Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: order in: query type: string description: Set the field and direction by which to order results. - name: limit in: query type: string description: The maximum number of results to show. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-customers-count.json path: /admin/api/unstable/customers/count.json operations: - name: deprecatedunstablegetcustomerscount method: GET description: Shopify Retrieves A Count Of All Customers outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-customers-customer_id-addresses.json path: /admin/api/unstable/customers/{customer_id}/addresses.json operations: - name: deprecatedunstablegetcustomersparamcustomeridaddresses method: GET description: Shopify Retrieves A List Of Addresses For A Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: admin-api-unstable-customers-customer_id-addresses-address_id}.json path: /admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json operations: - name: deprecatedunstablegetcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-unstable-customers-customer_id-orders.json path: /admin/api/unstable/customers/{customer_id}/orders.json operations: - name: deprecatedunstablegetcustomersparamcustomeridorders method: GET description: Shopify Retrieves All Orders Belonging To A Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: admin-api-unstable-deprecated_api_calls.json path: /admin/api/unstable/deprecated_api_calls.json operations: - name: deprecatedunstablegetdeprecatedapicalls method: GET description: Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-discount_codes-lookup.json path: /admin/api/unstable/discount_codes/lookup.json operations: - name: deprecatedunstablegetdiscountcodeslookup method: GET description: Shopify Retrieves The Location Of A Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: code in: query type: integer description: code - name: admin-api-unstable-events.json path: /admin/api/unstable/events.json operations: - name: deprecatedunstablegetevents method: GET description: Shopify Retrieves A List Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: since_id in: query type: string description: Show only results after the specified ID. - name: created_at_min in: query type: string description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: filter in: query type: string description: Show events specified in this filter. - name: verb in: query type: string description: Show events of a certain type. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-events-count.json path: /admin/api/unstable/events/count.json operations: - name: deprecatedunstablegeteventscount method: GET description: Shopify Retrieves A Count Of Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created_at_min in: query type: string description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' - name: admin-api-unstable-events-event_id}.json path: /admin/api/unstable/events/{event_id}.json operations: - name: deprecatedunstablegeteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-fulfillment_orders-fulfillment_order_id}.json path: /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}.json operations: - name: deprecatedunstablegetfulfillmentordersparamfulfillmentorderid method: GET description: Shopify Retrieves A Specific Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: admin-api-unstable-fulfillment_orders-fulfillment_order_id-fulfillments.json path: /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillments.json operations: - name: deprecatedunstablegetfulfillmentordersparamfulfillmentorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order that is associated with the fulfillments. - name: admin-api-unstable-fulfillment_orders-fulfillment_order_id-locations_for_move.js path: /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json operations: - name: deprecatedunstablegetfulfillmentordersparamfulfillmentorderidlocationsformove method: GET description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fulfillment_order_id in: path type: string description: fulfillment_order_id required: true - name: fulfillment_order_id in: query type: string description: The ID of the fulfillment order. - name: admin-api-unstable-gift_cards.json path: /admin/api/unstable/gift_cards.json operations: - name: deprecatedunstablegetgiftcards method: GET description: Shopify Retrieves A List Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Retrieve gift cards with a given status. Valid values:' - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-gift_cards-count.json path: /admin/api/unstable/gift_cards/count.json operations: - name: deprecatedunstablegetgiftcardscount method: GET description: Shopify Retrieves A Count Of Gift Cards outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: query type: string description: 'Count gift cards with a given status. Valid values:' - name: admin-api-unstable-gift_cards-gift_card_id}.json path: /admin/api/unstable/gift_cards/{gift_card_id}.json operations: - name: deprecatedunstablegetgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-unstable-inventory_items.json path: /admin/api/unstable/inventory_items.json operations: - name: deprecatedunstablegetinventoryitems method: GET description: Shopify Retrieves A List Of Inventory Items outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "ids\n required" in: query type: string description: Show only inventory items specified by a comma-separated list of IDs. - name: limit in: query type: string description: The maximum number of results to show. - name: ids in: query type: integer description: ids - name: admin-api-unstable-inventory_items-inventory_item_id}.json path: /admin/api/unstable/inventory_items/{inventory_item_id}.json operations: - name: deprecatedunstablegetinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-unstable-inventory_levels.json path: /admin/api/unstable/inventory_levels.json operations: - name: deprecatedunstablegetinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_ids in: query type: string description: A comma-separated list of inventory item IDs. - name: location_ids in: query type: string description: A comma-separated list of location IDs. To find the ID of a location, use the Location resource. - name: limit in: query type: string description: The maximum number of results to show. - name: updated_at_min in: query type: string description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' - name: admin-api-unstable-locations.json path: /admin/api/unstable/locations.json operations: - name: deprecatedunstablegetlocations method: GET description: Shopify Retrieves A List Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-locations-count.json path: /admin/api/unstable/locations/count.json operations: - name: deprecatedunstablegetlocationscount method: GET description: Shopify Retrieves A Count Of Locations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-locations-location_id}.json path: /admin/api/unstable/locations/{location_id}.json operations: - name: deprecatedunstablegetlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-unstable-locations-location_id-inventory_levels.json path: /admin/api/unstable/locations/{location_id}/inventory_levels.json operations: - name: deprecatedunstablegetlocationsparamlocationidinventorylevels method: GET description: Shopify Retrieves A List Of Inventory Levels For A Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-unstable-metafields.json path: /admin/api/unstable/metafields.json operations: - name: deprecatedunstablegetmetafields method: GET description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield[owner_id] in: query type: integer description: metafield[owner_id] - name: metafield[owner_resource] in: query type: string description: metafield[owner_resource] - name: admin-api-unstable-metafields-count.json path: /admin/api/unstable/metafields/count.json operations: - name: deprecatedunstablegetmetafieldscount method: GET description: Shopify Retrieves A Count Of A Resource's Metafields outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-metafields-metafield_id}.json path: /admin/api/unstable/metafields/{metafield_id}.json operations: - name: deprecatedunstablegetmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-orders-order_id-fulfillment_orders.json path: /admin/api/unstable/orders/{order_id}/fulfillment_orders.json operations: - name: deprecatedunstablegetordersparamorderidfulfillmentorders method: GET description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: order_id in: query type: string description: The ID of the order that is associated with the fulfillment orders. - name: admin-api-unstable-orders-order_id-fulfillments.json path: /admin/api/unstable/orders/{order_id}/fulfillments.json operations: - name: deprecatedunstablegetordersparamorderidfulfillments method: GET description: Shopify Retrieves Fulfillments Associated With An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_max in: query type: string description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: limit in: query type: string description: Limit the amount of results. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_max in: query type: string description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-unstable-orders-order_id-fulfillments-count.json path: /admin/api/unstable/orders/{order_id}/fulfillments/count.json operations: - name: deprecatedunstablegetordersparamorderidfulfillmentscount method: GET description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: created_at_min in: query type: string description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' - name: created_at_max in: query type: string description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_min in: query type: string description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-unstable-orders-order_id-fulfillments-fulfillment_id}.json path: /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}.json operations: - name: deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentid method: GET description: Shopify Retrieve A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fields in: query type: string description: Comma-separated list of fields to include in the response. - name: admin-api-unstable-orders-order_id-fulfillments-fulfillment_id-events.json path: /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events.json operations: - name: deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentidevents method: GET description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: fulfillment_id in: query type: string description: The ID of the fulfillment that's associated with the fulfillment event. - name: order_id in: query type: string description: The ID of the order that's associated with the fulfillment event. - name: admin-api-unstable-orders-order_id-fulfillments-fulfillment_id-events-event_id}. path: /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json operations: - name: deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentideventsparameventid method: GET description: Shopify Retrieves A Specific Fulfillment Event outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: fulfillment_id in: path type: string description: fulfillment_id required: true - name: event_id in: path type: string description: event_id required: true - name: event_id in: query type: string description: The ID of the fulfillment event. - name: admin-api-unstable-orders-order_id-refunds.json path: /admin/api/unstable/orders/{order_id}/refunds.json operations: - name: deprecatedunstablegetordersparamorderidrefunds method: GET description: Shopify Retrieves A List Of Refunds For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: limit in: query type: string description: The maximum number of results to retrieve. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-unstable-orders-order_id-refunds-refund_id}.json path: /admin/api/unstable/orders/{order_id}/refunds/{refund_id}.json operations: - name: deprecatedunstablegetordersparamorderidrefundsparamrefundid method: GET description: Shopify Retrieves A Specific Refund outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: refund_id in: path type: string description: refund_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: in_shop_currency in: query type: string description: Show amounts in the shop currency for the underlying transaction. - name: admin-api-unstable-orders-order_id-risks.json path: /admin/api/unstable/orders/{order_id}/risks.json operations: - name: deprecatedunstablegetordersparamorderidrisks method: GET description: Shopify Retrieves A List Of All Order Risks For An Order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: admin-api-unstable-orders-order_id-risks-risk_id}.json path: /admin/api/unstable/orders/{order_id}/risks/{risk_id}.json operations: - name: deprecatedunstablegetordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-unstable-policies.json path: /admin/api/unstable/policies.json operations: - name: deprecatedunstablegetpolicies method: GET description: Shopify Retrieves A List Of The Shop's Policies outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-price_rules-price_rule_id-batch-batch_id}.json path: /admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}.json operations: - name: deprecatedunstablegetpricerulesparampriceruleidbatchparambatchid method: GET description: Shopify Retrieves A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-unstable-price_rules-price_rule_id-batch-batch_id-discount_codes.json path: /admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json operations: - name: deprecatedunstablegetpricerulesparampriceruleidbatchparambatchiddiscountcodes method: GET description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: batch_id in: path type: string description: batch_id required: true - name: admin-api-unstable-price_rules-price_rule_id-discount_codes.json path: /admin/api/unstable/price_rules/{price_rule_id}/discount_codes.json operations: - name: deprecatedunstablegetpricerulesparampriceruleiddiscountcodes method: GET description: Shopify Retrieve A List Of Discount Codes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: admin-api-unstable-price_rules-price_rule_id-discount_codes-discount_code_id}.js path: /admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: deprecatedunstablegetpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-unstable-products.json path: /admin/api/unstable/products.json operations: - name: deprecatedunstablegetproducts method: GET description: Shopify Retrieves A List Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Return only products specified by a comma-separated list of product IDs. - name: limit in: query type: string description: Return up to this many results per page. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Filter results by product title. - name: vendor in: query type: string description: Filter results by product vendor. - name: handle in: query type: string description: Filter results by product handle. - name: product_type in: query type: string description: Filter results by product type. - name: status in: query type: string description: Return products by their status. - name: collection_id in: query type: string description: Filter results by product collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: presentment_currencies in: query type: string description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. - name: admin-api-unstable-products-count.json path: /admin/api/unstable/products/count.json operations: - name: deprecatedunstablegetproductscount method: GET description: Shopify Retrieves A Count Of Products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: vendor in: query type: string description: Filter results by product vendor. - name: product_type in: query type: string description: Filter results by product type. - name: collection_id in: query type: string description: Filter results by collection ID. - name: created_at_min in: query type: string description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Return products by their published status - name: admin-api-unstable-products-product_id}.json path: /admin/api/unstable/products/{product_id}.json operations: - name: deprecatedunstablegetproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-unstable-redirects.json path: /admin/api/unstable/redirects.json operations: - name: deprecatedunstablegetredirects method: GET description: Shopify Retrieves A List Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: path in: query type: string description: Show redirects with a given path. - name: target in: query type: string description: Show redirects with a given target. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-redirects-count.json path: /admin/api/unstable/redirects/count.json operations: - name: deprecatedunstablegetredirectscount method: GET description: Shopify Retrieves A Count Of Url Redirects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: path in: query type: string description: Count redirects with given path. - name: target in: query type: string description: Count redirects with given target. - name: admin-api-unstable-redirects-redirect_id}.json path: /admin/api/unstable/redirects/{redirect_id}.json operations: - name: deprecatedunstablegetredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-script_tags.json path: /admin/api/unstable/script_tags.json operations: - name: deprecatedunstablegetscripttags method: GET description: Shopify Retrieves A List Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: created_at_min in: query type: string description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: src in: query type: string description: Show script tags with this URL. - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-unstable-script_tags-count.json path: /admin/api/unstable/script_tags/count.json operations: - name: deprecatedunstablegetscripttagscount method: GET description: Shopify Retrieves A Count Of All Script Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: src in: query type: string description: Count only script tags with a given URL. - name: admin-api-unstable-script_tags-script_tag_id}.json path: /admin/api/unstable/script_tags/{script_tag_id}.json operations: - name: deprecatedunstablegetscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-unstable-shop.json path: /admin/api/unstable/shop.json operations: - name: deprecatedunstablegetshop method: GET description: Shopify Retrieves The Shop's Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-unstable-shopify_payments-balance.json path: /admin/api/unstable/shopify_payments/balance.json operations: - name: deprecatedunstablegetshopifypaymentsbalance method: GET description: Shopify Retrieves The Account's Current Balance outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-shopify_payments-payouts.json path: /admin/api/unstable/shopify_payments/payouts.json operations: - name: deprecatedunstablegetshopifypaymentspayouts method: GET description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: since_id in: query type: string description: Filter the response to payouts made after the specified ID. - name: last_id in: query type: string description: Filter the response to payouts made before the specified ID. - name: date_min in: query type: string description: Filter the response to payouts made inclusively after the specified date. - name: date_max in: query type: string description: Filter the response to payouts made inclusively before the specified date. - name: date in: query type: string description: Filter the response to payouts made on the specified date. - name: status in: query type: string description: Filter the response to payouts made with the specified status. - name: admin-api-unstable-shopify_payments-payouts-payout_id}.json path: /admin/api/unstable/shopify_payments/payouts/{payout_id}.json operations: - name: deprecatedunstablegetshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-unstable-smart_collections.json path: /admin/api/unstable/smart_collections.json operations: - name: deprecatedunstablegetsmartcollections method: GET description: Shopify Retrieves A List Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The number of results to show. - name: ids in: query type: string description: Show only the smart collections specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that includes the specified product. - name: handle in: query type: string description: Filter results by smart collection handle. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-smart_collections-count.json path: /admin/api/unstable/smart_collections/count.json operations: - name: deprecatedunstablegetsmartcollectionscount method: GET description: Shopify Retrieves A Count Of Smart Collections outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: title in: query type: string description: Show smart collections with the specified title. - name: product_id in: query type: string description: Show smart collections that include the specified product. - name: updated_at_min in: query type: string description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_min in: query type: string description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_at_max in: query type: string description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' - name: published_status in: query type: string description: Filter results based on the published status of smart collections. - name: admin-api-unstable-smart_collections-smart_collection_id}.json path: /admin/api/unstable/smart_collections/{smart_collection_id}.json operations: - name: deprecatedunstablegetsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-tender_transactions.json path: /admin/api/unstable/tender_transactions.json operations: - name: deprecatedunstablegettendertransactions method: GET description: Shopify Retrieves A List Of Tender Transactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to retrieve. - name: since_id in: query type: string description: Retrieve only transactions after the specified ID. - name: processed_at_min in: query type: string description: Show tender transactions processed_at or after the specified date. - name: processed_at_max in: query type: string description: Show tender transactions processed_at or before the specified date. - name: processed_at in: query type: string description: Show tender transactions processed at the specified date. - name: order in: query type: string description: Show tender transactions ordered by processed_at in ascending or descending order. - name: admin-api-unstable-themes.json path: /admin/api/unstable/themes.json operations: - name: deprecatedunstablegetthemes method: GET description: Shopify Retrieves A List Of Themes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-themes-theme_id}.json path: /admin/api/unstable/themes/{theme_id}.json operations: - name: deprecatedunstablegetthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-themes-theme_id-assets.json path: /admin/api/unstable/themes/{theme_id}/assets.json operations: - name: deprecatedunstablegetthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-unstable-users.json path: /admin/api/unstable/users.json operations: - name: deprecatedunstablegetusers method: GET description: Shopify Retrieves A List Of All Users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: string description: The maximum number of results to show on a page. - name: page_info in: query type: string description: A unique ID used to access a certain page of results. - name: admin-api-unstable-users-current.json path: /admin/api/unstable/users/current.json operations: - name: deprecatedunstablegetuserscurrent method: GET description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request outputRawFormat: json outputParameters: - name: result type: object value: $. - name: admin-api-unstable-users-user_id}.json path: /admin/api/unstable/users/{user_id}.json operations: - name: deprecatedunstablegetusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-unstable-webhooks.json path: /admin/api/unstable/webhooks.json operations: - name: deprecatedunstablegetwebhooks method: GET description: Shopify Retrieves A List Of Webhooks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: created_at_max in: query type: string description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: created_at_min in: query type: string description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: limit in: query type: string description: Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error. - name: since_id in: query type: string description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: updated_at_min in: query type: string description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: updated_at_max in: query type: string description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' - name: admin-api-unstable-webhooks-count.json path: /admin/api/unstable/webhooks/count.json operations: - name: deprecatedunstablegetwebhookscount method: GET description: Shopify Retrieves A Count Of Existing Webhook Subscriptions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: string description: Retrieve webhook subscriptions that send the POST request to this URI. - name: topic in: query type: string description: Show webhook subscriptions with a given topic. - name: admin-api-unstable-webhooks-webhook_id}.json path: /admin/api/unstable/webhooks/{webhook_id}.json operations: - name: deprecatedunstablegetwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho exposes: - type: rest namespace: shopify-retrieves-rest port: 8080 description: REST adapter for Shopify API — Retrieves. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/admin/api/2020-01/articles/authors-json name: admin-api-2020-01-articles-authors-json description: REST surface for admin-api-2020-01-articles-authors.json. operations: - method: GET name: deprecated202001getarticlesauthors description: Shopify Retrieves A List All Of Article Authors call: shopify-retrieves.deprecated202001getarticlesauthors outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/articles/tags-json name: admin-api-2020-01-articles-tags-json description: REST surface for admin-api-2020-01-articles-tags.json. operations: - method: GET name: deprecated202001getarticlestags description: Shopify Retrieves A List Of All The Tags call: shopify-retrieves.deprecated202001getarticlestags with: limit: rest.limit popular: rest.popular outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/assigned-fulfillment-orders-json name: admin-api-2020-01-assigned-fulfillment-orders-json description: REST surface for admin-api-2020-01-assigned_fulfillment_orders.json. operations: - method: GET name: deprecated202001getassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-retrieves.deprecated202001getassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/blogs-json name: admin-api-2020-01-blogs-json description: REST surface for admin-api-2020-01-blogs.json. operations: - method: GET name: deprecated202001getblogs description: Shopify Retrieve A List Of All Blogs call: shopify-retrieves.deprecated202001getblogs with: limit: rest.limit since_id: rest.since_id handle: rest.handle fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/blogs/{blog-id}/articles-json name: admin-api-2020-01-blogs-blog-id-articles-json description: REST surface for admin-api-2020-01-blogs-blog_id-articles.json. operations: - method: GET name: deprecated202001getblogsparamblogidarticles description: Shopify Retrieves A List Of All Articles From A Blog call: shopify-retrieves.deprecated202001getblogsparamblogidarticles with: blog_id: rest.blog_id limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status handle: rest.handle tag: rest.tag author: rest.author fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/blogs/{blog-id}/articles/count-json name: admin-api-2020-01-blogs-blog-id-articles-count-json description: REST surface for admin-api-2020-01-blogs-blog_id-articles-count.json. operations: - method: GET name: deprecated202001getblogsparamblogidarticlescount description: Shopify Retrieves A Count Of All Articles From A Blog call: shopify-retrieves.deprecated202001getblogsparamblogidarticlescount with: blog_id: rest.blog_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/blogs/{blog-id}/articles/article-id-json name: admin-api-2020-01-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-2020-01-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: deprecated202001getblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-retrieves.deprecated202001getblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/carrier-services-json name: admin-api-2020-01-carrier-services-json description: REST surface for admin-api-2020-01-carrier_services.json. operations: - method: GET name: deprecated202001getcarrierservices description: Shopify Retrieves A List Of Carrier Services call: shopify-retrieves.deprecated202001getcarrierservices outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/carrier-services/carrier-service-id-json name: admin-api-2020-01-carrier-services-carrier-service-id-json description: REST surface for admin-api-2020-01-carrier_services-carrier_service_id}.json. operations: - method: GET name: deprecated202001getcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-retrieves.deprecated202001getcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/checkouts/count-json name: admin-api-2020-01-checkouts-count-json description: REST surface for admin-api-2020-01-checkouts-count.json. operations: - method: GET name: deprecated202001getcheckoutscount description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days call: shopify-retrieves.deprecated202001getcheckoutscount with: since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/checkouts/token-json name: admin-api-2020-01-checkouts-token-json description: REST surface for admin-api-2020-01-checkouts-token}.json. operations: - method: GET name: deprecated202001getcheckoutsparamtoken description: Shopify Retrieves A Checkout call: shopify-retrieves.deprecated202001getcheckoutsparamtoken with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/checkouts/{token}/payments-json name: admin-api-2020-01-checkouts-token-payments-json description: REST surface for admin-api-2020-01-checkouts-token-payments.json. operations: - method: GET name: deprecated202001getcheckoutsparamtokenpayments description: Shopify Retrieves A List Of Payments On A Particular Checkout call: shopify-retrieves.deprecated202001getcheckoutsparamtokenpayments with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/checkouts/{token}/payments/payment-id-json name: admin-api-2020-01-checkouts-token-payments-payment-id-json description: REST surface for admin-api-2020-01-checkouts-token-payments-payment_id}.json. operations: - method: GET name: deprecated202001getcheckoutsparamtokenpaymentsparampaymentid description: Shopify Retrieves The Payment Information For An Existing Payment call: shopify-retrieves.deprecated202001getcheckoutsparamtokenpaymentsparampaymentid with: token: rest.token payment_id: rest.payment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/checkouts/{token}/shipping-rates-json name: admin-api-2020-01-checkouts-token-shipping-rates-json description: REST surface for admin-api-2020-01-checkouts-token-shipping_rates.json. operations: - method: GET name: deprecated202001getcheckoutsparamtokenshippingrates description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout call: shopify-retrieves.deprecated202001getcheckoutsparamtokenshippingrates with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/collection-listings-json name: admin-api-2020-01-collection-listings-json description: REST surface for admin-api-2020-01-collection_listings.json. operations: - method: GET name: deprecated202001getcollectionlistings description: Shopify Retrieve Collection Listings That Are Published To Your App call: shopify-retrieves.deprecated202001getcollectionlistings with: limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/collection-listings/collection-listing-id-json name: admin-api-2020-01-collection-listings-collection-listing-id-json description: REST surface for admin-api-2020-01-collection_listings-collection_listing_id}.json. operations: - method: GET name: deprecated202001getcollectionlistingsparamcollectionlistingid description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App call: shopify-retrieves.deprecated202001getcollectionlistingsparamcollectionlistingid with: collection_listing_id: rest.collection_listing_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/collection-listings/{collection-listing-id}/product-ids-json name: admin-api-2020-01-collection-listings-collection-listing-id-product-ids-json description: REST surface for admin-api-2020-01-collection_listings-collection_listing_id-product_ids.json. operations: - method: GET name: deprecated202001getcollectionlistingsparamcollectionlistingidproductids description: Shopify Retrieve Product_ids That Are Published To A Collection_id call: shopify-retrieves.deprecated202001getcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: rest.collection_listing_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/collections/collection-id-json name: admin-api-2020-01-collections-collection-id-json description: REST surface for admin-api-2020-01-collections-collection_id}.json. operations: - method: GET name: deprecated202001getcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-retrieves.deprecated202001getcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/collections/{collection-id}/products-json name: admin-api-2020-01-collections-collection-id-products-json description: REST surface for admin-api-2020-01-collections-collection_id-products.json. operations: - method: GET name: deprecated202001getcollectionsparamcollectionidproducts description: Shopify Retrieve A List Of Products Belonging To A Collection call: shopify-retrieves.deprecated202001getcollectionsparamcollectionidproducts with: collection_id: rest.collection_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/collects-json name: admin-api-2020-01-collects-json description: REST surface for admin-api-2020-01-collects.json. operations: - method: GET name: deprecated202001getcollects description: Shopify Retrieves A List Of Collects call: shopify-retrieves.deprecated202001getcollects with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/collects/count-json name: admin-api-2020-01-collects-count-json description: REST surface for admin-api-2020-01-collects-count.json. operations: - method: GET name: deprecated202001getcollectscount description: Shopify Retrieves A Count Of Collects call: shopify-retrieves.deprecated202001getcollectscount with: collection_id: rest.collection_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/collects/collect-id-json name: admin-api-2020-01-collects-collect-id-json description: REST surface for admin-api-2020-01-collects-collect_id}.json. operations: - method: GET name: deprecated202001getcollectsparamcollectid description: Shopify Retrieves A Specific Collect By Its Id call: shopify-retrieves.deprecated202001getcollectsparamcollectid with: collect_id: rest.collect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/comments-json name: admin-api-2020-01-comments-json description: REST surface for admin-api-2020-01-comments.json. operations: - method: GET name: deprecated202001getcomments description: Shopify Retrieves A List Of Comments call: shopify-retrieves.deprecated202001getcomments with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max fields: rest.fields published_status: rest.published_status status: rest.status article_id: rest.article_id blog_id: rest.blog_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/comments/count-json name: admin-api-2020-01-comments-count-json description: REST surface for admin-api-2020-01-comments-count.json. operations: - method: GET name: deprecated202001getcommentscount description: Shopify Retrieves A Count Of Comments call: shopify-retrieves.deprecated202001getcommentscount with: created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status status: rest.status article_id: rest.article_id blog_id: rest.blog_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/comments/comment-id-json name: admin-api-2020-01-comments-comment-id-json description: REST surface for admin-api-2020-01-comments-comment_id}.json. operations: - method: GET name: deprecated202001getcommentsparamcommentid description: Shopify Retrieves A Single Comment By Its Id call: shopify-retrieves.deprecated202001getcommentsparamcommentid with: comment_id: rest.comment_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/countries-json name: admin-api-2020-01-countries-json description: REST surface for admin-api-2020-01-countries.json. operations: - method: GET name: deprecated202001getcountries description: Shopify Retrieves A List Of Countries call: shopify-retrieves.deprecated202001getcountries with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/countries/count-json name: admin-api-2020-01-countries-count-json description: REST surface for admin-api-2020-01-countries-count.json. operations: - method: GET name: deprecated202001getcountriescount description: Shopify Retrieves A Count Of Countries call: shopify-retrieves.deprecated202001getcountriescount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/countries/country-id-json name: admin-api-2020-01-countries-country-id-json description: REST surface for admin-api-2020-01-countries-country_id}.json. operations: - method: GET name: deprecated202001getcountriesparamcountryid description: Shopify Retrieves A Specific County call: shopify-retrieves.deprecated202001getcountriesparamcountryid with: country_id: rest.country_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/countries/{country-id}/provinces-json name: admin-api-2020-01-countries-country-id-provinces-json description: REST surface for admin-api-2020-01-countries-country_id-provinces.json. operations: - method: GET name: deprecated202001getcountriesparamcountryidprovinces description: Shopify Retrieves A List Of Provinces call: shopify-retrieves.deprecated202001getcountriesparamcountryidprovinces with: country_id: rest.country_id since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/countries/{country-id}/provinces/count-json name: admin-api-2020-01-countries-country-id-provinces-count-json description: REST surface for admin-api-2020-01-countries-country_id-provinces-count.json. operations: - method: GET name: deprecated202001getcountriesparamcountryidprovincescount description: Shopify Retrieves A Count Of Provinces For A Country call: shopify-retrieves.deprecated202001getcountriesparamcountryidprovincescount with: country_id: rest.country_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/countries/{country-id}/provinces/province-id-json name: admin-api-2020-01-countries-country-id-provinces-province-id-json description: REST surface for admin-api-2020-01-countries-country_id-provinces-province_id}.json. operations: - method: GET name: deprecated202001getcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-retrieves.deprecated202001getcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/currencies-json name: admin-api-2020-01-currencies-json description: REST surface for admin-api-2020-01-currencies.json. operations: - method: GET name: deprecated202001getcurrencies description: Shopify Retrieves A List Of Currencies Enabled On A Shop call: shopify-retrieves.deprecated202001getcurrencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/custom-collections-json name: admin-api-2020-01-custom-collections-json description: REST surface for admin-api-2020-01-custom_collections.json. operations: - method: GET name: deprecated202001getcustomcollections description: Shopify Retrieves A List Of Custom Collections call: shopify-retrieves.deprecated202001getcustomcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/custom-collections/count-json name: admin-api-2020-01-custom-collections-count-json description: REST surface for admin-api-2020-01-custom_collections-count.json. operations: - method: GET name: deprecated202001getcustomcollectionscount description: Shopify Retrieves A Count Of Custom Collections call: shopify-retrieves.deprecated202001getcustomcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/custom-collections/custom-collection-id-json name: admin-api-2020-01-custom-collections-custom-collection-id-json description: REST surface for admin-api-2020-01-custom_collections-custom_collection_id}.json. operations: - method: GET name: deprecated202001getcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-retrieves.deprecated202001getcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customer-saved-searches-json name: admin-api-2020-01-customer-saved-searches-json description: REST surface for admin-api-2020-01-customer_saved_searches.json. operations: - method: GET name: deprecated202001getcustomersavedsearches description: Shopify Retrieves A List Of Customer Saved Searches call: shopify-retrieves.deprecated202001getcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customer-saved-searches/count-json name: admin-api-2020-01-customer-saved-searches-count-json description: REST surface for admin-api-2020-01-customer_saved_searches-count.json. operations: - method: GET name: deprecated202001getcustomersavedsearchescount description: Shopify Retrieves A Count Of All Customer Saved Searches call: shopify-retrieves.deprecated202001getcustomersavedsearchescount with: since_id: rest.since_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customer-saved-searches/customer-saved-search-id-json name: admin-api-2020-01-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-2020-01-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: deprecated202001getcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-retrieves.deprecated202001getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customer-saved-searches/{customer-saved-search-id}/customers-json name: admin-api-2020-01-customer-saved-searches-customer-saved-search-id-customers-jso description: REST surface for admin-api-2020-01-customer_saved_searches-customer_saved_search_id-customers.jso. operations: - method: GET name: deprecated202001getcustomersavedsearchesparamcustomersavedsearchidcustomers description: Shopify Retrieves All Customers Returned By A Customer Saved Search call: shopify-retrieves.deprecated202001getcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: rest.customer_saved_search_id order: rest.order limit: rest.limit fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customers/{customer-id}/addresses-json name: admin-api-2020-01-customers-customer-id-addresses-json description: REST surface for admin-api-2020-01-customers-customer_id-addresses.json. operations: - method: GET name: deprecated202001getcustomersparamcustomeridaddresses description: Shopify Retrieves A List Of Addresses For A Customer call: shopify-retrieves.deprecated202001getcustomersparamcustomeridaddresses with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customers/{customer-id}/addresses/address-id-json name: admin-api-2020-01-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-2020-01-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: deprecated202001getcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-retrieves.deprecated202001getcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/discount-codes/lookup-json name: admin-api-2020-01-discount-codes-lookup-json description: REST surface for admin-api-2020-01-discount_codes-lookup.json. operations: - method: GET name: deprecated202001getdiscountcodeslookup description: Shopify Retrieves The Location Of A Discount Code call: shopify-retrieves.deprecated202001getdiscountcodeslookup with: code: rest.code outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/events-json name: admin-api-2020-01-events-json description: REST surface for admin-api-2020-01-events.json. operations: - method: GET name: deprecated202001getevents description: Shopify Retrieves A List Of Events call: shopify-retrieves.deprecated202001getevents with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max filter: rest.filter verb: rest.verb fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/events/count-json name: admin-api-2020-01-events-count-json description: REST surface for admin-api-2020-01-events-count.json. operations: - method: GET name: deprecated202001geteventscount description: Shopify Retrieves A Count Of Events call: shopify-retrieves.deprecated202001geteventscount with: created_at_min: rest.created_at_min created_at_max: rest.created_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/events/event-id-json name: admin-api-2020-01-events-event-id-json description: REST surface for admin-api-2020-01-events-event_id}.json. operations: - method: GET name: deprecated202001geteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-retrieves.deprecated202001geteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/fulfillment-orders/fulfillment-order-id-json name: admin-api-2020-01-fulfillment-orders-fulfillment-order-id-json description: REST surface for admin-api-2020-01-fulfillment_orders-fulfillment_order_id}.json. operations: - method: GET name: deprecated202001getfulfillmentordersparamfulfillmentorderid description: Shopify Retrieves A Specific Fulfillment Order call: shopify-retrieves.deprecated202001getfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/fulfillment-orders/{fulfillment-order-id}/fulfillments-json name: admin-api-2020-01-fulfillment-orders-fulfillment-order-id-fulfillments-json description: REST surface for admin-api-2020-01-fulfillment_orders-fulfillment_order_id-fulfillments.json. operations: - method: GET name: deprecated202001getfulfillmentordersparamfulfillmentorderidfulfillments description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order call: shopify-retrieves.deprecated202001getfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/fulfillment-orders/{fulfillment-order-id}/locations-for-move-json name: admin-api-2020-01-fulfillment-orders-fulfillment-order-id-locations-for-move-jso description: REST surface for admin-api-2020-01-fulfillment_orders-fulfillment_order_id-locations_for_move.jso. operations: - method: GET name: deprecated202001getfulfillmentordersparamfulfillmentorderidlocationsformove description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To call: shopify-retrieves.deprecated202001getfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/gift-cards-json name: admin-api-2020-01-gift-cards-json description: REST surface for admin-api-2020-01-gift_cards.json. operations: - method: GET name: deprecated202001getgiftcards description: Shopify Retrieves A List Of Gift Cards call: shopify-retrieves.deprecated202001getgiftcards with: status: rest.status limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/gift-cards/count-json name: admin-api-2020-01-gift-cards-count-json description: REST surface for admin-api-2020-01-gift_cards-count.json. operations: - method: GET name: deprecated202001getgiftcardscount description: Shopify Retrieves A Count Of Gift Cards call: shopify-retrieves.deprecated202001getgiftcardscount with: status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/gift-cards/gift-card-id-json name: admin-api-2020-01-gift-cards-gift-card-id-json description: REST surface for admin-api-2020-01-gift_cards-gift_card_id}.json. operations: - method: GET name: deprecated202001getgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-retrieves.deprecated202001getgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/inventory-items-json name: admin-api-2020-01-inventory-items-json description: REST surface for admin-api-2020-01-inventory_items.json. operations: - method: GET name: deprecated202001getinventoryitems description: Shopify Retrieves A List Of Inventory Items call: shopify-retrieves.deprecated202001getinventoryitems with: ? "ids\n required" : "rest.ids\n required" limit: rest.limit ids: rest.ids outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/inventory-items/inventory-item-id-json name: admin-api-2020-01-inventory-items-inventory-item-id-json description: REST surface for admin-api-2020-01-inventory_items-inventory_item_id}.json. operations: - method: GET name: deprecated202001getinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-retrieves.deprecated202001getinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/inventory-levels-json name: admin-api-2020-01-inventory-levels-json description: REST surface for admin-api-2020-01-inventory_levels.json. operations: - method: GET name: deprecated202001getinventorylevels description: Shopify Retrieves A List Of Inventory Levels call: shopify-retrieves.deprecated202001getinventorylevels with: inventory_item_ids: rest.inventory_item_ids location_ids: rest.location_ids limit: rest.limit updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/locations-json name: admin-api-2020-01-locations-json description: REST surface for admin-api-2020-01-locations.json. operations: - method: GET name: deprecated202001getlocations description: Shopify Retrieves A List Of Locations call: shopify-retrieves.deprecated202001getlocations outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/locations/count-json name: admin-api-2020-01-locations-count-json description: REST surface for admin-api-2020-01-locations-count.json. operations: - method: GET name: deprecated202001getlocationscount description: Shopify Retrieves A Count Of Locations call: shopify-retrieves.deprecated202001getlocationscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/locations/location-id-json name: admin-api-2020-01-locations-location-id-json description: REST surface for admin-api-2020-01-locations-location_id}.json. operations: - method: GET name: deprecated202001getlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-retrieves.deprecated202001getlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/locations/{location-id}/inventory-levels-json name: admin-api-2020-01-locations-location-id-inventory-levels-json description: REST surface for admin-api-2020-01-locations-location_id-inventory_levels.json. operations: - method: GET name: deprecated202001getlocationsparamlocationidinventorylevels description: Shopify Retrieves A List Of Inventory Levels For A Location call: shopify-retrieves.deprecated202001getlocationsparamlocationidinventorylevels with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/metafields-json name: admin-api-2020-01-metafields-json description: REST surface for admin-api-2020-01-metafields.json. operations: - method: GET name: deprecated202001getmetafields description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource call: shopify-retrieves.deprecated202001getmetafields with: metafield[owner_id]: rest.metafield[owner_id] metafield[owner_resource]: rest.metafield[owner_resource] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/metafields/count-json name: admin-api-2020-01-metafields-count-json description: REST surface for admin-api-2020-01-metafields-count.json. operations: - method: GET name: deprecated202001getmetafieldscount description: Shopify Retrieves A Count Of A Resource's Metafields call: shopify-retrieves.deprecated202001getmetafieldscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/metafields/metafield-id-json name: admin-api-2020-01-metafields-metafield-id-json description: REST surface for admin-api-2020-01-metafields-metafield_id}.json. operations: - method: GET name: deprecated202001getmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-retrieves.deprecated202001getmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders-json name: admin-api-2020-01-orders-json description: REST surface for admin-api-2020-01-orders.json. operations: - method: GET name: deprecated202001getorders description: Shopify Retrieves A List Of Orders call: shopify-retrieves.deprecated202001getorders with: ids: rest.ids limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max attribution_app_id: rest.attribution_app_id status: rest.status financial_status: rest.financial_status fulfillment_status: rest.fulfillment_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/count-json name: admin-api-2020-01-orders-count-json description: REST surface for admin-api-2020-01-orders-count.json. operations: - method: GET name: deprecated202001getorderscount description: Shopify Retrieves An Order Count call: shopify-retrieves.deprecated202001getorderscount with: created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max status: rest.status financial_status: rest.financial_status fulfillment_status: rest.fulfillment_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/order-id-json name: admin-api-2020-01-orders-order-id-json description: REST surface for admin-api-2020-01-orders-order_id}.json. operations: - method: GET name: deprecated202001getordersparamorderid description: Shopify Retrieves A Specific Order call: shopify-retrieves.deprecated202001getordersparamorderid with: order_id: rest.order_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/fulfillment-orders-json name: admin-api-2020-01-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-2020-01-orders-order_id-fulfillment_orders.json. operations: - method: GET name: deprecated202001getordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-retrieves.deprecated202001getordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/fulfillments-json name: admin-api-2020-01-orders-order-id-fulfillments-json description: REST surface for admin-api-2020-01-orders-order_id-fulfillments.json. operations: - method: GET name: deprecated202001getordersparamorderidfulfillments description: Shopify Retrieves Fulfillments Associated With An Order call: shopify-retrieves.deprecated202001getordersparamorderidfulfillments with: order_id: rest.order_id created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id updated_at_max: rest.updated_at_max updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/fulfillments/count-json name: admin-api-2020-01-orders-order-id-fulfillments-count-json description: REST surface for admin-api-2020-01-orders-order_id-fulfillments-count.json. operations: - method: GET name: deprecated202001getordersparamorderidfulfillmentscount description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order call: shopify-retrieves.deprecated202001getordersparamorderidfulfillmentscount with: order_id: rest.order_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/fulfillments/fulfillment-id-json name: admin-api-2020-01-orders-order-id-fulfillments-fulfillment-id-json description: REST surface for admin-api-2020-01-orders-order_id-fulfillments-fulfillment_id}.json. operations: - method: GET name: deprecated202001getordersparamorderidfulfillmentsparamfulfillmentid description: Shopify Retrieve A Specific Fulfillment call: shopify-retrieves.deprecated202001getordersparamorderidfulfillmentsparamfulfillmentid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/fulfillments/{fulfillment-id}/events-json name: admin-api-2020-01-orders-order-id-fulfillments-fulfillment-id-events-json description: REST surface for admin-api-2020-01-orders-order_id-fulfillments-fulfillment_id-events.json. operations: - method: GET name: deprecated202001getordersparamorderidfulfillmentsparamfulfillmentidevents description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment call: shopify-retrieves.deprecated202001getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/fulfillments/{fulfillment-id}/events/event-id-json name: admin-api-2020-01-orders-order-id-fulfillments-fulfillment-id-events-event-id-j description: REST surface for admin-api-2020-01-orders-order_id-fulfillments-fulfillment_id-events-event_id}.j. operations: - method: GET name: deprecated202001getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid description: Shopify Retrieves A Specific Fulfillment Event call: shopify-retrieves.deprecated202001getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id event_id: rest.event_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/refunds-json name: admin-api-2020-01-orders-order-id-refunds-json description: REST surface for admin-api-2020-01-orders-order_id-refunds.json. operations: - method: GET name: deprecated202001getordersparamorderidrefunds description: Shopify Retrieves A List Of Refunds For An Order call: shopify-retrieves.deprecated202001getordersparamorderidrefunds with: order_id: rest.order_id limit: rest.limit fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/refunds/refund-id-json name: admin-api-2020-01-orders-order-id-refunds-refund-id-json description: REST surface for admin-api-2020-01-orders-order_id-refunds-refund_id}.json. operations: - method: GET name: deprecated202001getordersparamorderidrefundsparamrefundid description: Shopify Retrieves A Specific Refund call: shopify-retrieves.deprecated202001getordersparamorderidrefundsparamrefundid with: order_id: rest.order_id refund_id: rest.refund_id fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/risks-json name: admin-api-2020-01-orders-order-id-risks-json description: REST surface for admin-api-2020-01-orders-order_id-risks.json. operations: - method: GET name: deprecated202001getordersparamorderidrisks description: Shopify Retrieves A List Of All Order Risks For An Order call: shopify-retrieves.deprecated202001getordersparamorderidrisks with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/risks/risk-id-json name: admin-api-2020-01-orders-order-id-risks-risk-id-json description: REST surface for admin-api-2020-01-orders-order_id-risks-risk_id}.json. operations: - method: GET name: deprecated202001getordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-retrieves.deprecated202001getordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/policies-json name: admin-api-2020-01-policies-json description: REST surface for admin-api-2020-01-policies.json. operations: - method: GET name: deprecated202001getpolicies description: Shopify Retrieves A List Of The Shop's Policies call: shopify-retrieves.deprecated202001getpolicies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/price-rules/{price-rule-id}/batch/batch-id-json name: admin-api-2020-01-price-rules-price-rule-id-batch-batch-id-json description: REST surface for admin-api-2020-01-price_rules-price_rule_id-batch-batch_id}.json. operations: - method: GET name: deprecated202001getpricerulesparampriceruleidbatchparambatchid description: Shopify Retrieves A Discount Code Creation Job call: shopify-retrieves.deprecated202001getpricerulesparampriceruleidbatchparambatchid with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/price-rules/{price-rule-id}/batch/{batch-id}/discount-codes-json name: admin-api-2020-01-price-rules-price-rule-id-batch-batch-id-discount-codes-json description: REST surface for admin-api-2020-01-price_rules-price_rule_id-batch-batch_id-discount_codes.json. operations: - method: GET name: deprecated202001getpricerulesparampriceruleidbatchparambatchiddiscountcodes description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job call: shopify-retrieves.deprecated202001getpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/price-rules/{price-rule-id}/discount-codes-json name: admin-api-2020-01-price-rules-price-rule-id-discount-codes-json description: REST surface for admin-api-2020-01-price_rules-price_rule_id-discount_codes.json. operations: - method: GET name: deprecated202001getpricerulesparampriceruleiddiscountcodes description: Shopify Retrieve A List Of Discount Codes call: shopify-retrieves.deprecated202001getpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-2020-01-price-rules-price-rule-id-discount-codes-discount-code-id-jso description: REST surface for admin-api-2020-01-price_rules-price_rule_id-discount_codes-discount_code_id}.jso. operations: - method: GET name: deprecated202001getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-retrieves.deprecated202001getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/product-listings-json name: admin-api-2020-01-product-listings-json description: REST surface for admin-api-2020-01-product_listings.json. operations: - method: GET name: deprecated202001getproductlistings description: Shopify Retrieve Product Listings That Are Published To Your App call: shopify-retrieves.deprecated202001getproductlistings with: product_ids: rest.product_ids limit: rest.limit collection_id: rest.collection_id updated_at_min: rest.updated_at_min handle: rest.handle outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/product-listings/count-json name: admin-api-2020-01-product-listings-count-json description: REST surface for admin-api-2020-01-product_listings-count.json. operations: - method: GET name: deprecated202001getproductlistingscount description: Shopify Retrieve A Count Of Products That Are Published To Your App call: shopify-retrieves.deprecated202001getproductlistingscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/product-listings/product-ids-json name: admin-api-2020-01-product-listings-product-ids-json description: REST surface for admin-api-2020-01-product_listings-product_ids.json. operations: - method: GET name: deprecated202001getproductlistingsproductids description: Shopify Retrieve Product_ids That Are Published To Your App call: shopify-retrieves.deprecated202001getproductlistingsproductids with: limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/product-listings/product-listing-id-json name: admin-api-2020-01-product-listings-product-listing-id-json description: REST surface for admin-api-2020-01-product_listings-product_listing_id}.json. operations: - method: GET name: deprecated202001getproductlistingsparamproductlistingid description: Shopify Retrieve A Specific Product Listing That Is Published To Your App call: shopify-retrieves.deprecated202001getproductlistingsparamproductlistingid with: product_listing_id: rest.product_listing_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/products-json name: admin-api-2020-01-products-json description: REST surface for admin-api-2020-01-products.json. operations: - method: GET name: deprecated202001getproducts description: Shopify Retrieves A List Of Products call: shopify-retrieves.deprecated202001getproducts with: ids: rest.ids limit: rest.limit since_id: rest.since_id title: rest.title vendor: rest.vendor handle: rest.handle product_type: rest.product_type status: rest.status collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields presentment_currencies: rest.presentment_currencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/products/count-json name: admin-api-2020-01-products-count-json description: REST surface for admin-api-2020-01-products-count.json. operations: - method: GET name: deprecated202001getproductscount description: Shopify Retrieves A Count Of Products call: shopify-retrieves.deprecated202001getproductscount with: vendor: rest.vendor product_type: rest.product_type collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/products/product-id-json name: admin-api-2020-01-products-product-id-json description: REST surface for admin-api-2020-01-products-product_id}.json. operations: - method: GET name: deprecated202001getproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-retrieves.deprecated202001getproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/redirects-json name: admin-api-2020-01-redirects-json description: REST surface for admin-api-2020-01-redirects.json. operations: - method: GET name: deprecated202001getredirects description: Shopify Retrieves A List Of Url Redirects call: shopify-retrieves.deprecated202001getredirects with: limit: rest.limit since_id: rest.since_id path: rest.path target: rest.target fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/redirects/count-json name: admin-api-2020-01-redirects-count-json description: REST surface for admin-api-2020-01-redirects-count.json. operations: - method: GET name: deprecated202001getredirectscount description: Shopify Retrieves A Count Of Url Redirects call: shopify-retrieves.deprecated202001getredirectscount with: path: rest.path target: rest.target outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/redirects/redirect-id-json name: admin-api-2020-01-redirects-redirect-id-json description: REST surface for admin-api-2020-01-redirects-redirect_id}.json. operations: - method: GET name: deprecated202001getredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-retrieves.deprecated202001getredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/script-tags-json name: admin-api-2020-01-script-tags-json description: REST surface for admin-api-2020-01-script_tags.json. operations: - method: GET name: deprecated202001getscripttags description: Shopify Retrieves A List Of All Script Tags call: shopify-retrieves.deprecated202001getscripttags with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max src: rest.src fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/script-tags/count-json name: admin-api-2020-01-script-tags-count-json description: REST surface for admin-api-2020-01-script_tags-count.json. operations: - method: GET name: deprecated202001getscripttagscount description: Shopify Retrieves A Count Of All Script Tags call: shopify-retrieves.deprecated202001getscripttagscount with: src: rest.src outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/script-tags/script-tag-id-json name: admin-api-2020-01-script-tags-script-tag-id-json description: REST surface for admin-api-2020-01-script_tags-script_tag_id}.json. operations: - method: GET name: deprecated202001getscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-retrieves.deprecated202001getscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/shop-json name: admin-api-2020-01-shop-json description: REST surface for admin-api-2020-01-shop.json. operations: - method: GET name: deprecated202001getshop description: Shopify Retrieves The Shop's Configuration call: shopify-retrieves.deprecated202001getshop with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/shopify-payments/balance-json name: admin-api-2020-01-shopify-payments-balance-json description: REST surface for admin-api-2020-01-shopify_payments-balance.json. operations: - method: GET name: deprecated202001getshopifypaymentsbalance description: Shopify Retrieves The Account's Current Balance call: shopify-retrieves.deprecated202001getshopifypaymentsbalance outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/shopify-payments/balance/transactions-json name: admin-api-2020-01-shopify-payments-balance-transactions-json description: REST surface for admin-api-2020-01-shopify_payments-balance-transactions.json. operations: - method: GET name: deprecated202001getshopifypaymentsbalancetransactions description: Shopify Retrieves A List Of All Balance Transactions Ordered By Processingtime call: shopify-retrieves.deprecated202001getshopifypaymentsbalancetransactions with: since_id: rest.since_id last_id: rest.last_id test: rest.test payout_id: rest.payout_id payout_status: rest.payout_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/shopify-payments/disputes-json name: admin-api-2020-01-shopify-payments-disputes-json description: REST surface for admin-api-2020-01-shopify_payments-disputes.json. operations: - method: GET name: deprecated202001getshopifypaymentsdisputes description: Shopify Retrieve All Disputes Ordered By Initiated_at Date And Time (iso 8601 Format) call: shopify-retrieves.deprecated202001getshopifypaymentsdisputes with: since_id: rest.since_id last_id: rest.last_id status: rest.status initiated_at: rest.initiated_at outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/shopify-payments/disputes/dispute-id-json name: admin-api-2020-01-shopify-payments-disputes-dispute-id-json description: REST surface for admin-api-2020-01-shopify_payments-disputes-dispute_id}.json. operations: - method: GET name: deprecated202001getshopifypaymentsdisputesparamdisputeid description: Shopify Retrieves A Single Dispute By Id call: shopify-retrieves.deprecated202001getshopifypaymentsdisputesparamdisputeid with: dispute_id: rest.dispute_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/shopify-payments/payouts-json name: admin-api-2020-01-shopify-payments-payouts-json description: REST surface for admin-api-2020-01-shopify_payments-payouts.json. operations: - method: GET name: deprecated202001getshopifypaymentspayouts description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date call: shopify-retrieves.deprecated202001getshopifypaymentspayouts with: since_id: rest.since_id last_id: rest.last_id date_min: rest.date_min date_max: rest.date_max date: rest.date status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/shopify-payments/payouts/payout-id-json name: admin-api-2020-01-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-2020-01-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: deprecated202001getshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-retrieves.deprecated202001getshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/smart-collections-json name: admin-api-2020-01-smart-collections-json description: REST surface for admin-api-2020-01-smart_collections.json. operations: - method: GET name: deprecated202001getsmartcollections description: Shopify Retrieves A List Of Smart Collections call: shopify-retrieves.deprecated202001getsmartcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/smart-collections/count-json name: admin-api-2020-01-smart-collections-count-json description: REST surface for admin-api-2020-01-smart_collections-count.json. operations: - method: GET name: deprecated202001getsmartcollectionscount description: Shopify Retrieves A Count Of Smart Collections call: shopify-retrieves.deprecated202001getsmartcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/smart-collections/smart-collection-id-json name: admin-api-2020-01-smart-collections-smart-collection-id-json description: REST surface for admin-api-2020-01-smart_collections-smart_collection_id}.json. operations: - method: GET name: deprecated202001getsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-retrieves.deprecated202001getsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/tender-transactions-json name: admin-api-2020-01-tender-transactions-json description: REST surface for admin-api-2020-01-tender_transactions.json. operations: - method: GET name: deprecated202001gettendertransactions description: Shopify Retrieves A List Of Tender Transactions call: shopify-retrieves.deprecated202001gettendertransactions with: limit: rest.limit since_id: rest.since_id processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max processed_at: rest.processed_at order: rest.order outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/themes-json name: admin-api-2020-01-themes-json description: REST surface for admin-api-2020-01-themes.json. operations: - method: GET name: deprecated202001getthemes description: Shopify Retrieves A List Of Themes call: shopify-retrieves.deprecated202001getthemes with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/themes/theme-id-json name: admin-api-2020-01-themes-theme-id-json description: REST surface for admin-api-2020-01-themes-theme_id}.json. operations: - method: GET name: deprecated202001getthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-retrieves.deprecated202001getthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/themes/{theme-id}/assets-json name: admin-api-2020-01-themes-theme-id-assets-json description: REST surface for admin-api-2020-01-themes-theme_id-assets.json. operations: - method: GET name: deprecated202001getthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-retrieves.deprecated202001getthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/users-json name: admin-api-2020-01-users-json description: REST surface for admin-api-2020-01-users.json. operations: - method: GET name: deprecated202001getusers description: Shopify Retrieves A List Of All Users call: shopify-retrieves.deprecated202001getusers with: limit: rest.limit page_info: rest.page_info outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/users/current-json name: admin-api-2020-01-users-current-json description: REST surface for admin-api-2020-01-users-current.json. operations: - method: GET name: deprecated202001getuserscurrent description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request call: shopify-retrieves.deprecated202001getuserscurrent outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/users/user-id-json name: admin-api-2020-01-users-user-id-json description: REST surface for admin-api-2020-01-users-user_id}.json. operations: - method: GET name: deprecated202001getusersparamuserid description: Shopify Retrieves A Single User call: shopify-retrieves.deprecated202001getusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/webhooks-json name: admin-api-2020-01-webhooks-json description: REST surface for admin-api-2020-01-webhooks.json. operations: - method: GET name: deprecated202001getwebhooks description: Shopify Retrieves A List Of Webhooks call: shopify-retrieves.deprecated202001getwebhooks with: address: rest.address created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id topic: rest.topic updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/webhooks/count-json name: admin-api-2020-01-webhooks-count-json description: REST surface for admin-api-2020-01-webhooks-count.json. operations: - method: GET name: deprecated202001getwebhookscount description: Shopify Retrieves A Count Of Existing Webhook Subscriptions call: shopify-retrieves.deprecated202001getwebhookscount with: address: rest.address topic: rest.topic outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/webhooks/webhook-id-json name: admin-api-2020-01-webhooks-webhook-id-json description: REST surface for admin-api-2020-01-webhooks-webhook_id}.json. operations: - method: GET name: deprecated202001getwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-retrieves.deprecated202001getwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/articles/authors-json name: admin-api-2020-04-articles-authors-json description: REST surface for admin-api-2020-04-articles-authors.json. operations: - method: GET name: deprecated202004getarticlesauthors description: Shopify Retrieves A List All Of Article Authors call: shopify-retrieves.deprecated202004getarticlesauthors outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/articles/tags-json name: admin-api-2020-04-articles-tags-json description: REST surface for admin-api-2020-04-articles-tags.json. operations: - method: GET name: deprecated202004getarticlestags description: Shopify Retrieves A List Of All The Tags call: shopify-retrieves.deprecated202004getarticlestags with: limit: rest.limit popular: rest.popular outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/assigned-fulfillment-orders-json name: admin-api-2020-04-assigned-fulfillment-orders-json description: REST surface for admin-api-2020-04-assigned_fulfillment_orders.json. operations: - method: GET name: deprecated202004getassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-retrieves.deprecated202004getassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/blogs/{blog-id}/articles-json name: admin-api-2020-04-blogs-blog-id-articles-json description: REST surface for admin-api-2020-04-blogs-blog_id-articles.json. operations: - method: GET name: deprecated202004getblogsparamblogidarticles description: Shopify Retrieves A List Of All Articles From A Blog call: shopify-retrieves.deprecated202004getblogsparamblogidarticles with: blog_id: rest.blog_id limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status handle: rest.handle tag: rest.tag author: rest.author fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/blogs/{blog-id}/articles/count-json name: admin-api-2020-04-blogs-blog-id-articles-count-json description: REST surface for admin-api-2020-04-blogs-blog_id-articles-count.json. operations: - method: GET name: deprecated202004getblogsparamblogidarticlescount description: Shopify Retrieves A Count Of All Articles From A Blog call: shopify-retrieves.deprecated202004getblogsparamblogidarticlescount with: blog_id: rest.blog_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/blogs/{blog-id}/articles/article-id-json name: admin-api-2020-04-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-2020-04-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: deprecated202004getblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-retrieves.deprecated202004getblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/carrier-services-json name: admin-api-2020-04-carrier-services-json description: REST surface for admin-api-2020-04-carrier_services.json. operations: - method: GET name: deprecated202004getcarrierservices description: Shopify Retrieves A List Of Carrier Services call: shopify-retrieves.deprecated202004getcarrierservices outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/carrier-services/carrier-service-id-json name: admin-api-2020-04-carrier-services-carrier-service-id-json description: REST surface for admin-api-2020-04-carrier_services-carrier_service_id}.json. operations: - method: GET name: deprecated202004getcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-retrieves.deprecated202004getcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/checkouts/count-json name: admin-api-2020-04-checkouts-count-json description: REST surface for admin-api-2020-04-checkouts-count.json. operations: - method: GET name: deprecated202004getcheckoutscount description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days call: shopify-retrieves.deprecated202004getcheckoutscount with: since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/checkouts/token-json name: admin-api-2020-04-checkouts-token-json description: REST surface for admin-api-2020-04-checkouts-token}.json. operations: - method: GET name: deprecated202004getcheckoutsparamtoken description: Shopify Retrieves A Checkout call: shopify-retrieves.deprecated202004getcheckoutsparamtoken with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/checkouts/{token}/payments-json name: admin-api-2020-04-checkouts-token-payments-json description: REST surface for admin-api-2020-04-checkouts-token-payments.json. operations: - method: GET name: deprecated202004getcheckoutsparamtokenpayments description: Shopify Retrieves A List Of Payments On A Particular Checkout call: shopify-retrieves.deprecated202004getcheckoutsparamtokenpayments with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/checkouts/{token}/payments/payment-id-json name: admin-api-2020-04-checkouts-token-payments-payment-id-json description: REST surface for admin-api-2020-04-checkouts-token-payments-payment_id}.json. operations: - method: GET name: deprecated202004getcheckoutsparamtokenpaymentsparampaymentid description: Shopify Retrieves The Payment Information For An Existing Payment call: shopify-retrieves.deprecated202004getcheckoutsparamtokenpaymentsparampaymentid with: token: rest.token payment_id: rest.payment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/checkouts/{token}/shipping-rates-json name: admin-api-2020-04-checkouts-token-shipping-rates-json description: REST surface for admin-api-2020-04-checkouts-token-shipping_rates.json. operations: - method: GET name: deprecated202004getcheckoutsparamtokenshippingrates description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout call: shopify-retrieves.deprecated202004getcheckoutsparamtokenshippingrates with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/collection-listings-json name: admin-api-2020-04-collection-listings-json description: REST surface for admin-api-2020-04-collection_listings.json. operations: - method: GET name: deprecated202004getcollectionlistings description: Shopify Retrieve Collection Listings That Are Published To Your App call: shopify-retrieves.deprecated202004getcollectionlistings with: limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/collection-listings/collection-listing-id-json name: admin-api-2020-04-collection-listings-collection-listing-id-json description: REST surface for admin-api-2020-04-collection_listings-collection_listing_id}.json. operations: - method: GET name: deprecated202004getcollectionlistingsparamcollectionlistingid description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App call: shopify-retrieves.deprecated202004getcollectionlistingsparamcollectionlistingid with: collection_listing_id: rest.collection_listing_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/collection-listings/{collection-listing-id}/product-ids-json name: admin-api-2020-04-collection-listings-collection-listing-id-product-ids-json description: REST surface for admin-api-2020-04-collection_listings-collection_listing_id-product_ids.json. operations: - method: GET name: deprecated202004getcollectionlistingsparamcollectionlistingidproductids description: Shopify Retrieve Product_ids That Are Published To A Collection_id call: shopify-retrieves.deprecated202004getcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: rest.collection_listing_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/collections/collection-id-json name: admin-api-2020-04-collections-collection-id-json description: REST surface for admin-api-2020-04-collections-collection_id}.json. operations: - method: GET name: deprecated202004getcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-retrieves.deprecated202004getcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/collections/{collection-id}/products-json name: admin-api-2020-04-collections-collection-id-products-json description: REST surface for admin-api-2020-04-collections-collection_id-products.json. operations: - method: GET name: deprecated202004getcollectionsparamcollectionidproducts description: Shopify Retrieve A List Of Products Belonging To A Collection call: shopify-retrieves.deprecated202004getcollectionsparamcollectionidproducts with: collection_id: rest.collection_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/collects-json name: admin-api-2020-04-collects-json description: REST surface for admin-api-2020-04-collects.json. operations: - method: GET name: deprecated202004getcollects description: Shopify Retrieves A List Of Collects call: shopify-retrieves.deprecated202004getcollects with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/collects/count-json name: admin-api-2020-04-collects-count-json description: REST surface for admin-api-2020-04-collects-count.json. operations: - method: GET name: deprecated202004getcollectscount description: Shopify Retrieves A Count Of Collects call: shopify-retrieves.deprecated202004getcollectscount with: collection_id: rest.collection_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/collects/collect-id-json name: admin-api-2020-04-collects-collect-id-json description: REST surface for admin-api-2020-04-collects-collect_id}.json. operations: - method: GET name: deprecated202004getcollectsparamcollectid description: Shopify Retrieves A Specific Collect By Its Id call: shopify-retrieves.deprecated202004getcollectsparamcollectid with: collect_id: rest.collect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/countries-json name: admin-api-2020-04-countries-json description: REST surface for admin-api-2020-04-countries.json. operations: - method: GET name: deprecated202004getcountries description: Shopify Retrieves A List Of Countries call: shopify-retrieves.deprecated202004getcountries with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/countries/count-json name: admin-api-2020-04-countries-count-json description: REST surface for admin-api-2020-04-countries-count.json. operations: - method: GET name: deprecated202004getcountriescount description: Shopify Retrieves A Count Of Countries call: shopify-retrieves.deprecated202004getcountriescount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/countries/country-id-json name: admin-api-2020-04-countries-country-id-json description: REST surface for admin-api-2020-04-countries-country_id}.json. operations: - method: GET name: deprecated202004getcountriesparamcountryid description: Shopify Retrieves A Specific County call: shopify-retrieves.deprecated202004getcountriesparamcountryid with: country_id: rest.country_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/countries/{country-id}/provinces-json name: admin-api-2020-04-countries-country-id-provinces-json description: REST surface for admin-api-2020-04-countries-country_id-provinces.json. operations: - method: GET name: deprecated202004getcountriesparamcountryidprovinces description: Shopify Retrieves A List Of Provinces call: shopify-retrieves.deprecated202004getcountriesparamcountryidprovinces with: country_id: rest.country_id since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/countries/{country-id}/provinces/count-json name: admin-api-2020-04-countries-country-id-provinces-count-json description: REST surface for admin-api-2020-04-countries-country_id-provinces-count.json. operations: - method: GET name: deprecated202004getcountriesparamcountryidprovincescount description: Shopify Retrieves A Count Of Provinces For A Country call: shopify-retrieves.deprecated202004getcountriesparamcountryidprovincescount with: country_id: rest.country_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/countries/{country-id}/provinces/province-id-json name: admin-api-2020-04-countries-country-id-provinces-province-id-json description: REST surface for admin-api-2020-04-countries-country_id-provinces-province_id}.json. operations: - method: GET name: deprecated202004getcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-retrieves.deprecated202004getcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/currencies-json name: admin-api-2020-04-currencies-json description: REST surface for admin-api-2020-04-currencies.json. operations: - method: GET name: deprecated202004getcurrencies description: Shopify Retrieves A List Of Currencies Enabled On A Shop call: shopify-retrieves.deprecated202004getcurrencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/custom-collections-json name: admin-api-2020-04-custom-collections-json description: REST surface for admin-api-2020-04-custom_collections.json. operations: - method: GET name: deprecated202004getcustomcollections description: Shopify Retrieves A List Of Custom Collections call: shopify-retrieves.deprecated202004getcustomcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/custom-collections/count-json name: admin-api-2020-04-custom-collections-count-json description: REST surface for admin-api-2020-04-custom_collections-count.json. operations: - method: GET name: deprecated202004getcustomcollectionscount description: Shopify Retrieves A Count Of Custom Collections call: shopify-retrieves.deprecated202004getcustomcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/custom-collections/custom-collection-id-json name: admin-api-2020-04-custom-collections-custom-collection-id-json description: REST surface for admin-api-2020-04-custom_collections-custom_collection_id}.json. operations: - method: GET name: deprecated202004getcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-retrieves.deprecated202004getcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customer-saved-searches-json name: admin-api-2020-04-customer-saved-searches-json description: REST surface for admin-api-2020-04-customer_saved_searches.json. operations: - method: GET name: deprecated202004getcustomersavedsearches description: Shopify Retrieves A List Of Customer Saved Searches call: shopify-retrieves.deprecated202004getcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customer-saved-searches/count-json name: admin-api-2020-04-customer-saved-searches-count-json description: REST surface for admin-api-2020-04-customer_saved_searches-count.json. operations: - method: GET name: deprecated202004getcustomersavedsearchescount description: Shopify Retrieves A Count Of All Customer Saved Searches call: shopify-retrieves.deprecated202004getcustomersavedsearchescount with: since_id: rest.since_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customer-saved-searches/customer-saved-search-id-json name: admin-api-2020-04-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-2020-04-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: deprecated202004getcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-retrieves.deprecated202004getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customer-saved-searches/{customer-saved-search-id}/customers-json name: admin-api-2020-04-customer-saved-searches-customer-saved-search-id-customers-jso description: REST surface for admin-api-2020-04-customer_saved_searches-customer_saved_search_id-customers.jso. operations: - method: GET name: deprecated202004getcustomersavedsearchesparamcustomersavedsearchidcustomers description: Shopify Retrieves All Customers Returned By A Customer Saved Search call: shopify-retrieves.deprecated202004getcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: rest.customer_saved_search_id order: rest.order limit: rest.limit fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customers/{customer-id}/addresses-json name: admin-api-2020-04-customers-customer-id-addresses-json description: REST surface for admin-api-2020-04-customers-customer_id-addresses.json. operations: - method: GET name: deprecated202004getcustomersparamcustomeridaddresses description: Shopify Retrieves A List Of Addresses For A Customer call: shopify-retrieves.deprecated202004getcustomersparamcustomeridaddresses with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customers/{customer-id}/addresses/address-id-json name: admin-api-2020-04-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-2020-04-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: deprecated202004getcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-retrieves.deprecated202004getcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/discount-codes/lookup-json name: admin-api-2020-04-discount-codes-lookup-json description: REST surface for admin-api-2020-04-discount_codes-lookup.json. operations: - method: GET name: deprecated202004getdiscountcodeslookup description: Shopify Retrieves The Location Of A Discount Code call: shopify-retrieves.deprecated202004getdiscountcodeslookup with: code: rest.code outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/events-json name: admin-api-2020-04-events-json description: REST surface for admin-api-2020-04-events.json. operations: - method: GET name: deprecated202004getevents description: Shopify Retrieves A List Of Events call: shopify-retrieves.deprecated202004getevents with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max filter: rest.filter verb: rest.verb fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/events/count-json name: admin-api-2020-04-events-count-json description: REST surface for admin-api-2020-04-events-count.json. operations: - method: GET name: deprecated202004geteventscount description: Shopify Retrieves A Count Of Events call: shopify-retrieves.deprecated202004geteventscount with: created_at_min: rest.created_at_min created_at_max: rest.created_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/events/event-id-json name: admin-api-2020-04-events-event-id-json description: REST surface for admin-api-2020-04-events-event_id}.json. operations: - method: GET name: deprecated202004geteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-retrieves.deprecated202004geteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/fulfillment-orders/fulfillment-order-id-json name: admin-api-2020-04-fulfillment-orders-fulfillment-order-id-json description: REST surface for admin-api-2020-04-fulfillment_orders-fulfillment_order_id}.json. operations: - method: GET name: deprecated202004getfulfillmentordersparamfulfillmentorderid description: Shopify Retrieves A Specific Fulfillment Order call: shopify-retrieves.deprecated202004getfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/fulfillment-orders/{fulfillment-order-id}/fulfillments-json name: admin-api-2020-04-fulfillment-orders-fulfillment-order-id-fulfillments-json description: REST surface for admin-api-2020-04-fulfillment_orders-fulfillment_order_id-fulfillments.json. operations: - method: GET name: deprecated202004getfulfillmentordersparamfulfillmentorderidfulfillments description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order call: shopify-retrieves.deprecated202004getfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/fulfillment-orders/{fulfillment-order-id}/locations-for-move-json name: admin-api-2020-04-fulfillment-orders-fulfillment-order-id-locations-for-move-jso description: REST surface for admin-api-2020-04-fulfillment_orders-fulfillment_order_id-locations_for_move.jso. operations: - method: GET name: deprecated202004getfulfillmentordersparamfulfillmentorderidlocationsformove description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To call: shopify-retrieves.deprecated202004getfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/gift-cards-json name: admin-api-2020-04-gift-cards-json description: REST surface for admin-api-2020-04-gift_cards.json. operations: - method: GET name: deprecated202004getgiftcards description: Shopify Retrieves A List Of Gift Cards call: shopify-retrieves.deprecated202004getgiftcards with: status: rest.status limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/gift-cards/count-json name: admin-api-2020-04-gift-cards-count-json description: REST surface for admin-api-2020-04-gift_cards-count.json. operations: - method: GET name: deprecated202004getgiftcardscount description: Shopify Retrieves A Count Of Gift Cards call: shopify-retrieves.deprecated202004getgiftcardscount with: status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/gift-cards/gift-card-id-json name: admin-api-2020-04-gift-cards-gift-card-id-json description: REST surface for admin-api-2020-04-gift_cards-gift_card_id}.json. operations: - method: GET name: deprecated202004getgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-retrieves.deprecated202004getgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/inventory-items-json name: admin-api-2020-04-inventory-items-json description: REST surface for admin-api-2020-04-inventory_items.json. operations: - method: GET name: deprecated202004getinventoryitems description: Shopify Retrieves A List Of Inventory Items call: shopify-retrieves.deprecated202004getinventoryitems with: ? "ids\n required" : "rest.ids\n required" limit: rest.limit ids: rest.ids outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/inventory-items/inventory-item-id-json name: admin-api-2020-04-inventory-items-inventory-item-id-json description: REST surface for admin-api-2020-04-inventory_items-inventory_item_id}.json. operations: - method: GET name: deprecated202004getinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-retrieves.deprecated202004getinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/inventory-levels-json name: admin-api-2020-04-inventory-levels-json description: REST surface for admin-api-2020-04-inventory_levels.json. operations: - method: GET name: deprecated202004getinventorylevels description: Shopify Retrieves A List Of Inventory Levels call: shopify-retrieves.deprecated202004getinventorylevels with: inventory_item_ids: rest.inventory_item_ids location_ids: rest.location_ids limit: rest.limit updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/locations-json name: admin-api-2020-04-locations-json description: REST surface for admin-api-2020-04-locations.json. operations: - method: GET name: deprecated202004getlocations description: Shopify Retrieves A List Of Locations call: shopify-retrieves.deprecated202004getlocations outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/locations/count-json name: admin-api-2020-04-locations-count-json description: REST surface for admin-api-2020-04-locations-count.json. operations: - method: GET name: deprecated202004getlocationscount description: Shopify Retrieves A Count Of Locations call: shopify-retrieves.deprecated202004getlocationscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/locations/location-id-json name: admin-api-2020-04-locations-location-id-json description: REST surface for admin-api-2020-04-locations-location_id}.json. operations: - method: GET name: deprecated202004getlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-retrieves.deprecated202004getlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/locations/{location-id}/inventory-levels-json name: admin-api-2020-04-locations-location-id-inventory-levels-json description: REST surface for admin-api-2020-04-locations-location_id-inventory_levels.json. operations: - method: GET name: deprecated202004getlocationsparamlocationidinventorylevels description: Shopify Retrieves A List Of Inventory Levels For A Location call: shopify-retrieves.deprecated202004getlocationsparamlocationidinventorylevels with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/metafields-json name: admin-api-2020-04-metafields-json description: REST surface for admin-api-2020-04-metafields.json. operations: - method: GET name: deprecated202004getmetafields description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource call: shopify-retrieves.deprecated202004getmetafields with: metafield[owner_id]: rest.metafield[owner_id] metafield[owner_resource]: rest.metafield[owner_resource] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/metafields/count-json name: admin-api-2020-04-metafields-count-json description: REST surface for admin-api-2020-04-metafields-count.json. operations: - method: GET name: deprecated202004getmetafieldscount description: Shopify Retrieves A Count Of A Resource's Metafields call: shopify-retrieves.deprecated202004getmetafieldscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/metafields/metafield-id-json name: admin-api-2020-04-metafields-metafield-id-json description: REST surface for admin-api-2020-04-metafields-metafield_id}.json. operations: - method: GET name: deprecated202004getmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-retrieves.deprecated202004getmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders-json name: admin-api-2020-04-orders-json description: REST surface for admin-api-2020-04-orders.json. operations: - method: GET name: deprecated202004getorders description: Shopify Retrieves A List Of Orders call: shopify-retrieves.deprecated202004getorders with: ids: rest.ids limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max attribution_app_id: rest.attribution_app_id status: rest.status financial_status: rest.financial_status fulfillment_status: rest.fulfillment_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/count-json name: admin-api-2020-04-orders-count-json description: REST surface for admin-api-2020-04-orders-count.json. operations: - method: GET name: deprecated202004getorderscount description: Shopify Retrieves An Order Count call: shopify-retrieves.deprecated202004getorderscount with: created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max status: rest.status financial_status: rest.financial_status fulfillment_status: rest.fulfillment_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/order-id-json name: admin-api-2020-04-orders-order-id-json description: REST surface for admin-api-2020-04-orders-order_id}.json. operations: - method: GET name: deprecated202004getordersparamorderid description: Shopify Retrieves A Specific Order call: shopify-retrieves.deprecated202004getordersparamorderid with: order_id: rest.order_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/fulfillment-orders-json name: admin-api-2020-04-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-2020-04-orders-order_id-fulfillment_orders.json. operations: - method: GET name: deprecated202004getordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-retrieves.deprecated202004getordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/fulfillments-json name: admin-api-2020-04-orders-order-id-fulfillments-json description: REST surface for admin-api-2020-04-orders-order_id-fulfillments.json. operations: - method: GET name: deprecated202004getordersparamorderidfulfillments description: Shopify Retrieves Fulfillments Associated With An Order call: shopify-retrieves.deprecated202004getordersparamorderidfulfillments with: order_id: rest.order_id created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id updated_at_max: rest.updated_at_max updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/fulfillments/count-json name: admin-api-2020-04-orders-order-id-fulfillments-count-json description: REST surface for admin-api-2020-04-orders-order_id-fulfillments-count.json. operations: - method: GET name: deprecated202004getordersparamorderidfulfillmentscount description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order call: shopify-retrieves.deprecated202004getordersparamorderidfulfillmentscount with: order_id: rest.order_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/fulfillments/fulfillment-id-json name: admin-api-2020-04-orders-order-id-fulfillments-fulfillment-id-json description: REST surface for admin-api-2020-04-orders-order_id-fulfillments-fulfillment_id}.json. operations: - method: GET name: deprecated202004getordersparamorderidfulfillmentsparamfulfillmentid description: Shopify Retrieve A Specific Fulfillment call: shopify-retrieves.deprecated202004getordersparamorderidfulfillmentsparamfulfillmentid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/fulfillments/{fulfillment-id}/events-json name: admin-api-2020-04-orders-order-id-fulfillments-fulfillment-id-events-json description: REST surface for admin-api-2020-04-orders-order_id-fulfillments-fulfillment_id-events.json. operations: - method: GET name: deprecated202004getordersparamorderidfulfillmentsparamfulfillmentidevents description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment call: shopify-retrieves.deprecated202004getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/fulfillments/{fulfillment-id}/events/event-id-json name: admin-api-2020-04-orders-order-id-fulfillments-fulfillment-id-events-event-id-j description: REST surface for admin-api-2020-04-orders-order_id-fulfillments-fulfillment_id-events-event_id}.j. operations: - method: GET name: deprecated202004getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid description: Shopify Retrieves A Specific Fulfillment Event call: shopify-retrieves.deprecated202004getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id event_id: rest.event_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/refunds-json name: admin-api-2020-04-orders-order-id-refunds-json description: REST surface for admin-api-2020-04-orders-order_id-refunds.json. operations: - method: GET name: deprecated202004getordersparamorderidrefunds description: Shopify Retrieves A List Of Refunds For An Order call: shopify-retrieves.deprecated202004getordersparamorderidrefunds with: order_id: rest.order_id limit: rest.limit fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/refunds/refund-id-json name: admin-api-2020-04-orders-order-id-refunds-refund-id-json description: REST surface for admin-api-2020-04-orders-order_id-refunds-refund_id}.json. operations: - method: GET name: deprecated202004getordersparamorderidrefundsparamrefundid description: Shopify Retrieves A Specific Refund call: shopify-retrieves.deprecated202004getordersparamorderidrefundsparamrefundid with: order_id: rest.order_id refund_id: rest.refund_id fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/risks-json name: admin-api-2020-04-orders-order-id-risks-json description: REST surface for admin-api-2020-04-orders-order_id-risks.json. operations: - method: GET name: deprecated202004getordersparamorderidrisks description: Shopify Retrieves A List Of All Order Risks For An Order call: shopify-retrieves.deprecated202004getordersparamorderidrisks with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/risks/risk-id-json name: admin-api-2020-04-orders-order-id-risks-risk-id-json description: REST surface for admin-api-2020-04-orders-order_id-risks-risk_id}.json. operations: - method: GET name: deprecated202004getordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-retrieves.deprecated202004getordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/policies-json name: admin-api-2020-04-policies-json description: REST surface for admin-api-2020-04-policies.json. operations: - method: GET name: deprecated202004getpolicies description: Shopify Retrieves A List Of The Shop's Policies call: shopify-retrieves.deprecated202004getpolicies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/price-rules/{price-rule-id}/batch/batch-id-json name: admin-api-2020-04-price-rules-price-rule-id-batch-batch-id-json description: REST surface for admin-api-2020-04-price_rules-price_rule_id-batch-batch_id}.json. operations: - method: GET name: deprecated202004getpricerulesparampriceruleidbatchparambatchid description: Shopify Retrieves A Discount Code Creation Job call: shopify-retrieves.deprecated202004getpricerulesparampriceruleidbatchparambatchid with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/price-rules/{price-rule-id}/batch/{batch-id}/discount-codes-json name: admin-api-2020-04-price-rules-price-rule-id-batch-batch-id-discount-codes-json description: REST surface for admin-api-2020-04-price_rules-price_rule_id-batch-batch_id-discount_codes.json. operations: - method: GET name: deprecated202004getpricerulesparampriceruleidbatchparambatchiddiscountcodes description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job call: shopify-retrieves.deprecated202004getpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/price-rules/{price-rule-id}/discount-codes-json name: admin-api-2020-04-price-rules-price-rule-id-discount-codes-json description: REST surface for admin-api-2020-04-price_rules-price_rule_id-discount_codes.json. operations: - method: GET name: deprecated202004getpricerulesparampriceruleiddiscountcodes description: Shopify Retrieve A List Of Discount Codes call: shopify-retrieves.deprecated202004getpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-2020-04-price-rules-price-rule-id-discount-codes-discount-code-id-jso description: REST surface for admin-api-2020-04-price_rules-price_rule_id-discount_codes-discount_code_id}.jso. operations: - method: GET name: deprecated202004getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-retrieves.deprecated202004getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/product-listings-json name: admin-api-2020-04-product-listings-json description: REST surface for admin-api-2020-04-product_listings.json. operations: - method: GET name: deprecated202004getproductlistings description: Shopify Retrieve Product Listings That Are Published To Your App call: shopify-retrieves.deprecated202004getproductlistings with: product_ids: rest.product_ids limit: rest.limit collection_id: rest.collection_id updated_at_min: rest.updated_at_min handle: rest.handle outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/product-listings/count-json name: admin-api-2020-04-product-listings-count-json description: REST surface for admin-api-2020-04-product_listings-count.json. operations: - method: GET name: deprecated202004getproductlistingscount description: Shopify Retrieve A Count Of Products That Are Published To Your App call: shopify-retrieves.deprecated202004getproductlistingscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/product-listings/product-ids-json name: admin-api-2020-04-product-listings-product-ids-json description: REST surface for admin-api-2020-04-product_listings-product_ids.json. operations: - method: GET name: deprecated202004getproductlistingsproductids description: Shopify Retrieve Product_ids That Are Published To Your App call: shopify-retrieves.deprecated202004getproductlistingsproductids with: limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/product-listings/product-listing-id-json name: admin-api-2020-04-product-listings-product-listing-id-json description: REST surface for admin-api-2020-04-product_listings-product_listing_id}.json. operations: - method: GET name: deprecated202004getproductlistingsparamproductlistingid description: Shopify Retrieve A Specific Product Listing That Is Published To Your App call: shopify-retrieves.deprecated202004getproductlistingsparamproductlistingid with: product_listing_id: rest.product_listing_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/products-json name: admin-api-2020-04-products-json description: REST surface for admin-api-2020-04-products.json. operations: - method: GET name: deprecated202004getproducts description: Shopify Retrieves A List Of Products call: shopify-retrieves.deprecated202004getproducts with: ids: rest.ids limit: rest.limit since_id: rest.since_id title: rest.title vendor: rest.vendor handle: rest.handle product_type: rest.product_type status: rest.status collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields presentment_currencies: rest.presentment_currencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/products/count-json name: admin-api-2020-04-products-count-json description: REST surface for admin-api-2020-04-products-count.json. operations: - method: GET name: deprecated202004getproductscount description: Shopify Retrieves A Count Of Products call: shopify-retrieves.deprecated202004getproductscount with: vendor: rest.vendor product_type: rest.product_type collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/products/product-id-json name: admin-api-2020-04-products-product-id-json description: REST surface for admin-api-2020-04-products-product_id}.json. operations: - method: GET name: deprecated202004getproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-retrieves.deprecated202004getproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/redirects-json name: admin-api-2020-04-redirects-json description: REST surface for admin-api-2020-04-redirects.json. operations: - method: GET name: deprecated202004getredirects description: Shopify Retrieves A List Of Url Redirects call: shopify-retrieves.deprecated202004getredirects with: limit: rest.limit since_id: rest.since_id path: rest.path target: rest.target fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/redirects/count-json name: admin-api-2020-04-redirects-count-json description: REST surface for admin-api-2020-04-redirects-count.json. operations: - method: GET name: deprecated202004getredirectscount description: Shopify Retrieves A Count Of Url Redirects call: shopify-retrieves.deprecated202004getredirectscount with: path: rest.path target: rest.target outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/redirects/redirect-id-json name: admin-api-2020-04-redirects-redirect-id-json description: REST surface for admin-api-2020-04-redirects-redirect_id}.json. operations: - method: GET name: deprecated202004getredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-retrieves.deprecated202004getredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/script-tags-json name: admin-api-2020-04-script-tags-json description: REST surface for admin-api-2020-04-script_tags.json. operations: - method: GET name: deprecated202004getscripttags description: Shopify Retrieves A List Of All Script Tags call: shopify-retrieves.deprecated202004getscripttags with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max src: rest.src fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/script-tags/count-json name: admin-api-2020-04-script-tags-count-json description: REST surface for admin-api-2020-04-script_tags-count.json. operations: - method: GET name: deprecated202004getscripttagscount description: Shopify Retrieves A Count Of All Script Tags call: shopify-retrieves.deprecated202004getscripttagscount with: src: rest.src outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/script-tags/script-tag-id-json name: admin-api-2020-04-script-tags-script-tag-id-json description: REST surface for admin-api-2020-04-script_tags-script_tag_id}.json. operations: - method: GET name: deprecated202004getscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-retrieves.deprecated202004getscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/shop-json name: admin-api-2020-04-shop-json description: REST surface for admin-api-2020-04-shop.json. operations: - method: GET name: deprecated202004getshop description: Shopify Retrieves The Shop's Configuration call: shopify-retrieves.deprecated202004getshop with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/shopify-payments/balance-json name: admin-api-2020-04-shopify-payments-balance-json description: REST surface for admin-api-2020-04-shopify_payments-balance.json. operations: - method: GET name: deprecated202004getshopifypaymentsbalance description: Shopify Retrieves The Account's Current Balance call: shopify-retrieves.deprecated202004getshopifypaymentsbalance outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/shopify-payments/disputes-json name: admin-api-2020-04-shopify-payments-disputes-json description: REST surface for admin-api-2020-04-shopify_payments-disputes.json. operations: - method: GET name: deprecated202004getshopifypaymentsdisputes description: Shopify Retrieve All Disputes Ordered By Initiated_at Date And Time (iso 8601 Format) call: shopify-retrieves.deprecated202004getshopifypaymentsdisputes with: since_id: rest.since_id last_id: rest.last_id status: rest.status initiated_at: rest.initiated_at outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/shopify-payments/payouts-json name: admin-api-2020-04-shopify-payments-payouts-json description: REST surface for admin-api-2020-04-shopify_payments-payouts.json. operations: - method: GET name: deprecated202004getshopifypaymentspayouts description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date call: shopify-retrieves.deprecated202004getshopifypaymentspayouts with: since_id: rest.since_id last_id: rest.last_id date_min: rest.date_min date_max: rest.date_max date: rest.date status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/shopify-payments/payouts/payout-id-json name: admin-api-2020-04-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-2020-04-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: deprecated202004getshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-retrieves.deprecated202004getshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/smart-collections-json name: admin-api-2020-04-smart-collections-json description: REST surface for admin-api-2020-04-smart_collections.json. operations: - method: GET name: deprecated202004getsmartcollections description: Shopify Retrieves A List Of Smart Collections call: shopify-retrieves.deprecated202004getsmartcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/smart-collections/count-json name: admin-api-2020-04-smart-collections-count-json description: REST surface for admin-api-2020-04-smart_collections-count.json. operations: - method: GET name: deprecated202004getsmartcollectionscount description: Shopify Retrieves A Count Of Smart Collections call: shopify-retrieves.deprecated202004getsmartcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/smart-collections/smart-collection-id-json name: admin-api-2020-04-smart-collections-smart-collection-id-json description: REST surface for admin-api-2020-04-smart_collections-smart_collection_id}.json. operations: - method: GET name: deprecated202004getsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-retrieves.deprecated202004getsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/tender-transactions-json name: admin-api-2020-04-tender-transactions-json description: REST surface for admin-api-2020-04-tender_transactions.json. operations: - method: GET name: deprecated202004gettendertransactions description: Shopify Retrieves A List Of Tender Transactions call: shopify-retrieves.deprecated202004gettendertransactions with: limit: rest.limit since_id: rest.since_id processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max processed_at: rest.processed_at order: rest.order outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/themes-json name: admin-api-2020-04-themes-json description: REST surface for admin-api-2020-04-themes.json. operations: - method: GET name: deprecated202004getthemes description: Shopify Retrieves A List Of Themes call: shopify-retrieves.deprecated202004getthemes with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/themes/theme-id-json name: admin-api-2020-04-themes-theme-id-json description: REST surface for admin-api-2020-04-themes-theme_id}.json. operations: - method: GET name: deprecated202004getthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-retrieves.deprecated202004getthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/themes/{theme-id}/assets-json name: admin-api-2020-04-themes-theme-id-assets-json description: REST surface for admin-api-2020-04-themes-theme_id-assets.json. operations: - method: GET name: deprecated202004getthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-retrieves.deprecated202004getthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/users-json name: admin-api-2020-04-users-json description: REST surface for admin-api-2020-04-users.json. operations: - method: GET name: deprecated202004getusers description: Shopify Retrieves A List Of All Users call: shopify-retrieves.deprecated202004getusers with: limit: rest.limit page_info: rest.page_info outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/users/current-json name: admin-api-2020-04-users-current-json description: REST surface for admin-api-2020-04-users-current.json. operations: - method: GET name: deprecated202004getuserscurrent description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request call: shopify-retrieves.deprecated202004getuserscurrent outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/users/user-id-json name: admin-api-2020-04-users-user-id-json description: REST surface for admin-api-2020-04-users-user_id}.json. operations: - method: GET name: deprecated202004getusersparamuserid description: Shopify Retrieves A Single User call: shopify-retrieves.deprecated202004getusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/webhooks-json name: admin-api-2020-04-webhooks-json description: REST surface for admin-api-2020-04-webhooks.json. operations: - method: GET name: deprecated202004getwebhooks description: Shopify Retrieves A List Of Webhooks call: shopify-retrieves.deprecated202004getwebhooks with: address: rest.address created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id topic: rest.topic updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/webhooks/count-json name: admin-api-2020-04-webhooks-count-json description: REST surface for admin-api-2020-04-webhooks-count.json. operations: - method: GET name: deprecated202004getwebhookscount description: Shopify Retrieves A Count Of Existing Webhook Subscriptions call: shopify-retrieves.deprecated202004getwebhookscount with: address: rest.address topic: rest.topic outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/webhooks/webhook-id-json name: admin-api-2020-04-webhooks-webhook-id-json description: REST surface for admin-api-2020-04-webhooks-webhook_id}.json. operations: - method: GET name: deprecated202004getwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-retrieves.deprecated202004getwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/articles/authors-json name: admin-api-2020-07-articles-authors-json description: REST surface for admin-api-2020-07-articles-authors.json. operations: - method: GET name: deprecated202007getarticlesauthors description: Shopify Retrieves A List All Of Article Authors call: shopify-retrieves.deprecated202007getarticlesauthors outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/articles/tags-json name: admin-api-2020-07-articles-tags-json description: REST surface for admin-api-2020-07-articles-tags.json. operations: - method: GET name: deprecated202007getarticlestags description: Shopify Retrieves A List Of All The Tags call: shopify-retrieves.deprecated202007getarticlestags with: limit: rest.limit popular: rest.popular outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/assigned-fulfillment-orders-json name: admin-api-2020-07-assigned-fulfillment-orders-json description: REST surface for admin-api-2020-07-assigned_fulfillment_orders.json. operations: - method: GET name: deprecated202007getassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-retrieves.deprecated202007getassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/blogs/{blog-id}/articles-json name: admin-api-2020-07-blogs-blog-id-articles-json description: REST surface for admin-api-2020-07-blogs-blog_id-articles.json. operations: - method: GET name: deprecated202007getblogsparamblogidarticles description: Shopify Retrieves A List Of All Articles From A Blog call: shopify-retrieves.deprecated202007getblogsparamblogidarticles with: blog_id: rest.blog_id limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status handle: rest.handle tag: rest.tag author: rest.author fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/blogs/{blog-id}/articles/count-json name: admin-api-2020-07-blogs-blog-id-articles-count-json description: REST surface for admin-api-2020-07-blogs-blog_id-articles-count.json. operations: - method: GET name: deprecated202007getblogsparamblogidarticlescount description: Shopify Retrieves A Count Of All Articles From A Blog call: shopify-retrieves.deprecated202007getblogsparamblogidarticlescount with: blog_id: rest.blog_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/blogs/{blog-id}/articles/article-id-json name: admin-api-2020-07-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-2020-07-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: deprecated202007getblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-retrieves.deprecated202007getblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/carrier-services-json name: admin-api-2020-07-carrier-services-json description: REST surface for admin-api-2020-07-carrier_services.json. operations: - method: GET name: deprecated202007getcarrierservices description: Shopify Retrieves A List Of Carrier Services call: shopify-retrieves.deprecated202007getcarrierservices outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/carrier-services/carrier-service-id-json name: admin-api-2020-07-carrier-services-carrier-service-id-json description: REST surface for admin-api-2020-07-carrier_services-carrier_service_id}.json. operations: - method: GET name: deprecated202007getcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-retrieves.deprecated202007getcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/checkouts/count-json name: admin-api-2020-07-checkouts-count-json description: REST surface for admin-api-2020-07-checkouts-count.json. operations: - method: GET name: deprecated202007getcheckoutscount description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days call: shopify-retrieves.deprecated202007getcheckoutscount with: since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/checkouts/token-json name: admin-api-2020-07-checkouts-token-json description: REST surface for admin-api-2020-07-checkouts-token}.json. operations: - method: GET name: deprecated202007getcheckoutsparamtoken description: Shopify Retrieves A Checkout call: shopify-retrieves.deprecated202007getcheckoutsparamtoken with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/checkouts/{token}/payments-json name: admin-api-2020-07-checkouts-token-payments-json description: REST surface for admin-api-2020-07-checkouts-token-payments.json. operations: - method: GET name: deprecated202007getcheckoutsparamtokenpayments description: Shopify Retrieves A List Of Payments On A Particular Checkout call: shopify-retrieves.deprecated202007getcheckoutsparamtokenpayments with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/checkouts/{token}/payments/payment-id-json name: admin-api-2020-07-checkouts-token-payments-payment-id-json description: REST surface for admin-api-2020-07-checkouts-token-payments-payment_id}.json. operations: - method: GET name: deprecated202007getcheckoutsparamtokenpaymentsparampaymentid description: Shopify Retrieves The Payment Information For An Existing Payment call: shopify-retrieves.deprecated202007getcheckoutsparamtokenpaymentsparampaymentid with: token: rest.token payment_id: rest.payment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/checkouts/{token}/shipping-rates-json name: admin-api-2020-07-checkouts-token-shipping-rates-json description: REST surface for admin-api-2020-07-checkouts-token-shipping_rates.json. operations: - method: GET name: deprecated202007getcheckoutsparamtokenshippingrates description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout call: shopify-retrieves.deprecated202007getcheckoutsparamtokenshippingrates with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/collection-listings-json name: admin-api-2020-07-collection-listings-json description: REST surface for admin-api-2020-07-collection_listings.json. operations: - method: GET name: deprecated202007getcollectionlistings description: Shopify Retrieve Collection Listings That Are Published To Your App call: shopify-retrieves.deprecated202007getcollectionlistings with: limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/collection-listings/collection-listing-id-json name: admin-api-2020-07-collection-listings-collection-listing-id-json description: REST surface for admin-api-2020-07-collection_listings-collection_listing_id}.json. operations: - method: GET name: deprecated202007getcollectionlistingsparamcollectionlistingid description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App call: shopify-retrieves.deprecated202007getcollectionlistingsparamcollectionlistingid with: collection_listing_id: rest.collection_listing_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/collection-listings/{collection-listing-id}/product-ids-json name: admin-api-2020-07-collection-listings-collection-listing-id-product-ids-json description: REST surface for admin-api-2020-07-collection_listings-collection_listing_id-product_ids.json. operations: - method: GET name: deprecated202007getcollectionlistingsparamcollectionlistingidproductids description: Shopify Retrieve Product_ids That Are Published To A Collection_id call: shopify-retrieves.deprecated202007getcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: rest.collection_listing_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/collections/collection-id-json name: admin-api-2020-07-collections-collection-id-json description: REST surface for admin-api-2020-07-collections-collection_id}.json. operations: - method: GET name: deprecated202007getcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-retrieves.deprecated202007getcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/collections/{collection-id}/products-json name: admin-api-2020-07-collections-collection-id-products-json description: REST surface for admin-api-2020-07-collections-collection_id-products.json. operations: - method: GET name: deprecated202007getcollectionsparamcollectionidproducts description: Shopify Retrieve A List Of Products Belonging To A Collection call: shopify-retrieves.deprecated202007getcollectionsparamcollectionidproducts with: collection_id: rest.collection_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/collects-json name: admin-api-2020-07-collects-json description: REST surface for admin-api-2020-07-collects.json. operations: - method: GET name: deprecated202007getcollects description: Shopify Retrieves A List Of Collects call: shopify-retrieves.deprecated202007getcollects with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/collects/count-json name: admin-api-2020-07-collects-count-json description: REST surface for admin-api-2020-07-collects-count.json. operations: - method: GET name: deprecated202007getcollectscount description: Shopify Retrieves A Count Of Collects call: shopify-retrieves.deprecated202007getcollectscount with: collection_id: rest.collection_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/collects/collect-id-json name: admin-api-2020-07-collects-collect-id-json description: REST surface for admin-api-2020-07-collects-collect_id}.json. operations: - method: GET name: deprecated202007getcollectsparamcollectid description: Shopify Retrieves A Specific Collect By Its Id call: shopify-retrieves.deprecated202007getcollectsparamcollectid with: collect_id: rest.collect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/countries-json name: admin-api-2020-07-countries-json description: REST surface for admin-api-2020-07-countries.json. operations: - method: GET name: deprecated202007getcountries description: Shopify Retrieves A List Of Countries call: shopify-retrieves.deprecated202007getcountries with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/countries/count-json name: admin-api-2020-07-countries-count-json description: REST surface for admin-api-2020-07-countries-count.json. operations: - method: GET name: deprecated202007getcountriescount description: Shopify Retrieves A Count Of Countries call: shopify-retrieves.deprecated202007getcountriescount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/countries/country-id-json name: admin-api-2020-07-countries-country-id-json description: REST surface for admin-api-2020-07-countries-country_id}.json. operations: - method: GET name: deprecated202007getcountriesparamcountryid description: Shopify Retrieves A Specific County call: shopify-retrieves.deprecated202007getcountriesparamcountryid with: country_id: rest.country_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/countries/{country-id}/provinces-json name: admin-api-2020-07-countries-country-id-provinces-json description: REST surface for admin-api-2020-07-countries-country_id-provinces.json. operations: - method: GET name: deprecated202007getcountriesparamcountryidprovinces description: Shopify Retrieves A List Of Provinces call: shopify-retrieves.deprecated202007getcountriesparamcountryidprovinces with: country_id: rest.country_id since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/countries/{country-id}/provinces/count-json name: admin-api-2020-07-countries-country-id-provinces-count-json description: REST surface for admin-api-2020-07-countries-country_id-provinces-count.json. operations: - method: GET name: deprecated202007getcountriesparamcountryidprovincescount description: Shopify Retrieves A Count Of Provinces For A Country call: shopify-retrieves.deprecated202007getcountriesparamcountryidprovincescount with: country_id: rest.country_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/countries/{country-id}/provinces/province-id-json name: admin-api-2020-07-countries-country-id-provinces-province-id-json description: REST surface for admin-api-2020-07-countries-country_id-provinces-province_id}.json. operations: - method: GET name: deprecated202007getcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-retrieves.deprecated202007getcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/currencies-json name: admin-api-2020-07-currencies-json description: REST surface for admin-api-2020-07-currencies.json. operations: - method: GET name: deprecated202007getcurrencies description: Shopify Retrieves A List Of Currencies Enabled On A Shop call: shopify-retrieves.deprecated202007getcurrencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/custom-collections-json name: admin-api-2020-07-custom-collections-json description: REST surface for admin-api-2020-07-custom_collections.json. operations: - method: GET name: deprecated202007getcustomcollections description: Shopify Retrieves A List Of Custom Collections call: shopify-retrieves.deprecated202007getcustomcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/custom-collections/count-json name: admin-api-2020-07-custom-collections-count-json description: REST surface for admin-api-2020-07-custom_collections-count.json. operations: - method: GET name: deprecated202007getcustomcollectionscount description: Shopify Retrieves A Count Of Custom Collections call: shopify-retrieves.deprecated202007getcustomcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/custom-collections/custom-collection-id-json name: admin-api-2020-07-custom-collections-custom-collection-id-json description: REST surface for admin-api-2020-07-custom_collections-custom_collection_id}.json. operations: - method: GET name: deprecated202007getcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-retrieves.deprecated202007getcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customer-saved-searches-json name: admin-api-2020-07-customer-saved-searches-json description: REST surface for admin-api-2020-07-customer_saved_searches.json. operations: - method: GET name: deprecated202007getcustomersavedsearches description: Shopify Retrieves A List Of Customer Saved Searches call: shopify-retrieves.deprecated202007getcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customer-saved-searches/count-json name: admin-api-2020-07-customer-saved-searches-count-json description: REST surface for admin-api-2020-07-customer_saved_searches-count.json. operations: - method: GET name: deprecated202007getcustomersavedsearchescount description: Shopify Retrieves A Count Of All Customer Saved Searches call: shopify-retrieves.deprecated202007getcustomersavedsearchescount with: since_id: rest.since_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customer-saved-searches/customer-saved-search-id-json name: admin-api-2020-07-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-2020-07-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: deprecated202007getcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-retrieves.deprecated202007getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customer-saved-searches/{customer-saved-search-id}/customers-json name: admin-api-2020-07-customer-saved-searches-customer-saved-search-id-customers-jso description: REST surface for admin-api-2020-07-customer_saved_searches-customer_saved_search_id-customers.jso. operations: - method: GET name: deprecated202007getcustomersavedsearchesparamcustomersavedsearchidcustomers description: Shopify Retrieves All Customers Returned By A Customer Saved Search call: shopify-retrieves.deprecated202007getcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: rest.customer_saved_search_id order: rest.order limit: rest.limit fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customers/{customer-id}/addresses-json name: admin-api-2020-07-customers-customer-id-addresses-json description: REST surface for admin-api-2020-07-customers-customer_id-addresses.json. operations: - method: GET name: deprecated202007getcustomersparamcustomeridaddresses description: Shopify Retrieves A List Of Addresses For A Customer call: shopify-retrieves.deprecated202007getcustomersparamcustomeridaddresses with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customers/{customer-id}/addresses/address-id-json name: admin-api-2020-07-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-2020-07-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: deprecated202007getcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-retrieves.deprecated202007getcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/discount-codes/lookup-json name: admin-api-2020-07-discount-codes-lookup-json description: REST surface for admin-api-2020-07-discount_codes-lookup.json. operations: - method: GET name: deprecated202007getdiscountcodeslookup description: Shopify Retrieves The Location Of A Discount Code call: shopify-retrieves.deprecated202007getdiscountcodeslookup with: code: rest.code outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/events-json name: admin-api-2020-07-events-json description: REST surface for admin-api-2020-07-events.json. operations: - method: GET name: deprecated202007getevents description: Shopify Retrieves A List Of Events call: shopify-retrieves.deprecated202007getevents with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max filter: rest.filter verb: rest.verb fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/events/count-json name: admin-api-2020-07-events-count-json description: REST surface for admin-api-2020-07-events-count.json. operations: - method: GET name: deprecated202007geteventscount description: Shopify Retrieves A Count Of Events call: shopify-retrieves.deprecated202007geteventscount with: created_at_min: rest.created_at_min created_at_max: rest.created_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/events/event-id-json name: admin-api-2020-07-events-event-id-json description: REST surface for admin-api-2020-07-events-event_id}.json. operations: - method: GET name: deprecated202007geteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-retrieves.deprecated202007geteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/fulfillment-orders/fulfillment-order-id-json name: admin-api-2020-07-fulfillment-orders-fulfillment-order-id-json description: REST surface for admin-api-2020-07-fulfillment_orders-fulfillment_order_id}.json. operations: - method: GET name: deprecated202007getfulfillmentordersparamfulfillmentorderid description: Shopify Retrieves A Specific Fulfillment Order call: shopify-retrieves.deprecated202007getfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/fulfillment-orders/{fulfillment-order-id}/fulfillments-json name: admin-api-2020-07-fulfillment-orders-fulfillment-order-id-fulfillments-json description: REST surface for admin-api-2020-07-fulfillment_orders-fulfillment_order_id-fulfillments.json. operations: - method: GET name: deprecated202007getfulfillmentordersparamfulfillmentorderidfulfillments description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order call: shopify-retrieves.deprecated202007getfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/fulfillment-orders/{fulfillment-order-id}/locations-for-move-json name: admin-api-2020-07-fulfillment-orders-fulfillment-order-id-locations-for-move-jso description: REST surface for admin-api-2020-07-fulfillment_orders-fulfillment_order_id-locations_for_move.jso. operations: - method: GET name: deprecated202007getfulfillmentordersparamfulfillmentorderidlocationsformove description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To call: shopify-retrieves.deprecated202007getfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/gift-cards-json name: admin-api-2020-07-gift-cards-json description: REST surface for admin-api-2020-07-gift_cards.json. operations: - method: GET name: deprecated202007getgiftcards description: Shopify Retrieves A List Of Gift Cards call: shopify-retrieves.deprecated202007getgiftcards with: status: rest.status limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/gift-cards/count-json name: admin-api-2020-07-gift-cards-count-json description: REST surface for admin-api-2020-07-gift_cards-count.json. operations: - method: GET name: deprecated202007getgiftcardscount description: Shopify Retrieves A Count Of Gift Cards call: shopify-retrieves.deprecated202007getgiftcardscount with: status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/gift-cards/gift-card-id-json name: admin-api-2020-07-gift-cards-gift-card-id-json description: REST surface for admin-api-2020-07-gift_cards-gift_card_id}.json. operations: - method: GET name: deprecated202007getgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-retrieves.deprecated202007getgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/inventory-items-json name: admin-api-2020-07-inventory-items-json description: REST surface for admin-api-2020-07-inventory_items.json. operations: - method: GET name: deprecated202007getinventoryitems description: Shopify Retrieves A List Of Inventory Items call: shopify-retrieves.deprecated202007getinventoryitems with: ? "ids\n required" : "rest.ids\n required" limit: rest.limit ids: rest.ids outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/inventory-items/inventory-item-id-json name: admin-api-2020-07-inventory-items-inventory-item-id-json description: REST surface for admin-api-2020-07-inventory_items-inventory_item_id}.json. operations: - method: GET name: deprecated202007getinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-retrieves.deprecated202007getinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/inventory-levels-json name: admin-api-2020-07-inventory-levels-json description: REST surface for admin-api-2020-07-inventory_levels.json. operations: - method: GET name: deprecated202007getinventorylevels description: Shopify Retrieves A List Of Inventory Levels call: shopify-retrieves.deprecated202007getinventorylevels with: inventory_item_ids: rest.inventory_item_ids location_ids: rest.location_ids limit: rest.limit updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/locations-json name: admin-api-2020-07-locations-json description: REST surface for admin-api-2020-07-locations.json. operations: - method: GET name: deprecated202007getlocations description: Shopify Retrieves A List Of Locations call: shopify-retrieves.deprecated202007getlocations outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/locations/count-json name: admin-api-2020-07-locations-count-json description: REST surface for admin-api-2020-07-locations-count.json. operations: - method: GET name: deprecated202007getlocationscount description: Shopify Retrieves A Count Of Locations call: shopify-retrieves.deprecated202007getlocationscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/locations/location-id-json name: admin-api-2020-07-locations-location-id-json description: REST surface for admin-api-2020-07-locations-location_id}.json. operations: - method: GET name: deprecated202007getlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-retrieves.deprecated202007getlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/locations/{location-id}/inventory-levels-json name: admin-api-2020-07-locations-location-id-inventory-levels-json description: REST surface for admin-api-2020-07-locations-location_id-inventory_levels.json. operations: - method: GET name: deprecated202007getlocationsparamlocationidinventorylevels description: Shopify Retrieves A List Of Inventory Levels For A Location call: shopify-retrieves.deprecated202007getlocationsparamlocationidinventorylevels with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/metafields-json name: admin-api-2020-07-metafields-json description: REST surface for admin-api-2020-07-metafields.json. operations: - method: GET name: deprecated202007getmetafields description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource call: shopify-retrieves.deprecated202007getmetafields with: metafield[owner_id]: rest.metafield[owner_id] metafield[owner_resource]: rest.metafield[owner_resource] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/metafields/count-json name: admin-api-2020-07-metafields-count-json description: REST surface for admin-api-2020-07-metafields-count.json. operations: - method: GET name: deprecated202007getmetafieldscount description: Shopify Retrieves A Count Of A Resource's Metafields call: shopify-retrieves.deprecated202007getmetafieldscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/metafields/metafield-id-json name: admin-api-2020-07-metafields-metafield-id-json description: REST surface for admin-api-2020-07-metafields-metafield_id}.json. operations: - method: GET name: deprecated202007getmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-retrieves.deprecated202007getmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders-json name: admin-api-2020-07-orders-json description: REST surface for admin-api-2020-07-orders.json. operations: - method: GET name: deprecated202007getorders description: Shopify Retrieves A List Of Orders call: shopify-retrieves.deprecated202007getorders with: ids: rest.ids limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max attribution_app_id: rest.attribution_app_id status: rest.status financial_status: rest.financial_status fulfillment_status: rest.fulfillment_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/fulfillment-orders-json name: admin-api-2020-07-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-2020-07-orders-order_id-fulfillment_orders.json. operations: - method: GET name: deprecated202007getordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-retrieves.deprecated202007getordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/fulfillments-json name: admin-api-2020-07-orders-order-id-fulfillments-json description: REST surface for admin-api-2020-07-orders-order_id-fulfillments.json. operations: - method: GET name: deprecated202007getordersparamorderidfulfillments description: Shopify Retrieves Fulfillments Associated With An Order call: shopify-retrieves.deprecated202007getordersparamorderidfulfillments with: order_id: rest.order_id created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id updated_at_max: rest.updated_at_max updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/fulfillments/count-json name: admin-api-2020-07-orders-order-id-fulfillments-count-json description: REST surface for admin-api-2020-07-orders-order_id-fulfillments-count.json. operations: - method: GET name: deprecated202007getordersparamorderidfulfillmentscount description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order call: shopify-retrieves.deprecated202007getordersparamorderidfulfillmentscount with: order_id: rest.order_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/fulfillments/fulfillment-id-json name: admin-api-2020-07-orders-order-id-fulfillments-fulfillment-id-json description: REST surface for admin-api-2020-07-orders-order_id-fulfillments-fulfillment_id}.json. operations: - method: GET name: deprecated202007getordersparamorderidfulfillmentsparamfulfillmentid description: Shopify Retrieve A Specific Fulfillment call: shopify-retrieves.deprecated202007getordersparamorderidfulfillmentsparamfulfillmentid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/fulfillments/{fulfillment-id}/events-json name: admin-api-2020-07-orders-order-id-fulfillments-fulfillment-id-events-json description: REST surface for admin-api-2020-07-orders-order_id-fulfillments-fulfillment_id-events.json. operations: - method: GET name: deprecated202007getordersparamorderidfulfillmentsparamfulfillmentidevents description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment call: shopify-retrieves.deprecated202007getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/fulfillments/{fulfillment-id}/events/event-id-json name: admin-api-2020-07-orders-order-id-fulfillments-fulfillment-id-events-event-id-j description: REST surface for admin-api-2020-07-orders-order_id-fulfillments-fulfillment_id-events-event_id}.j. operations: - method: GET name: deprecated202007getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid description: Shopify Retrieves A Specific Fulfillment Event call: shopify-retrieves.deprecated202007getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id event_id: rest.event_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/refunds-json name: admin-api-2020-07-orders-order-id-refunds-json description: REST surface for admin-api-2020-07-orders-order_id-refunds.json. operations: - method: GET name: deprecated202007getordersparamorderidrefunds description: Shopify Retrieves A List Of Refunds For An Order call: shopify-retrieves.deprecated202007getordersparamorderidrefunds with: order_id: rest.order_id limit: rest.limit fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/refunds/refund-id-json name: admin-api-2020-07-orders-order-id-refunds-refund-id-json description: REST surface for admin-api-2020-07-orders-order_id-refunds-refund_id}.json. operations: - method: GET name: deprecated202007getordersparamorderidrefundsparamrefundid description: Shopify Retrieves A Specific Refund call: shopify-retrieves.deprecated202007getordersparamorderidrefundsparamrefundid with: order_id: rest.order_id refund_id: rest.refund_id fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/risks-json name: admin-api-2020-07-orders-order-id-risks-json description: REST surface for admin-api-2020-07-orders-order_id-risks.json. operations: - method: GET name: deprecated202007getordersparamorderidrisks description: Shopify Retrieves A List Of All Order Risks For An Order call: shopify-retrieves.deprecated202007getordersparamorderidrisks with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/risks/risk-id-json name: admin-api-2020-07-orders-order-id-risks-risk-id-json description: REST surface for admin-api-2020-07-orders-order_id-risks-risk_id}.json. operations: - method: GET name: deprecated202007getordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-retrieves.deprecated202007getordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/policies-json name: admin-api-2020-07-policies-json description: REST surface for admin-api-2020-07-policies.json. operations: - method: GET name: deprecated202007getpolicies description: Shopify Retrieves A List Of The Shop's Policies call: shopify-retrieves.deprecated202007getpolicies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/price-rules/{price-rule-id}/batch/batch-id-json name: admin-api-2020-07-price-rules-price-rule-id-batch-batch-id-json description: REST surface for admin-api-2020-07-price_rules-price_rule_id-batch-batch_id}.json. operations: - method: GET name: deprecated202007getpricerulesparampriceruleidbatchparambatchid description: Shopify Retrieves A Discount Code Creation Job call: shopify-retrieves.deprecated202007getpricerulesparampriceruleidbatchparambatchid with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/price-rules/{price-rule-id}/batch/{batch-id}/discount-codes-json name: admin-api-2020-07-price-rules-price-rule-id-batch-batch-id-discount-codes-json description: REST surface for admin-api-2020-07-price_rules-price_rule_id-batch-batch_id-discount_codes.json. operations: - method: GET name: deprecated202007getpricerulesparampriceruleidbatchparambatchiddiscountcodes description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job call: shopify-retrieves.deprecated202007getpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/price-rules/{price-rule-id}/discount-codes-json name: admin-api-2020-07-price-rules-price-rule-id-discount-codes-json description: REST surface for admin-api-2020-07-price_rules-price_rule_id-discount_codes.json. operations: - method: GET name: deprecated202007getpricerulesparampriceruleiddiscountcodes description: Shopify Retrieve A List Of Discount Codes call: shopify-retrieves.deprecated202007getpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-2020-07-price-rules-price-rule-id-discount-codes-discount-code-id-jso description: REST surface for admin-api-2020-07-price_rules-price_rule_id-discount_codes-discount_code_id}.jso. operations: - method: GET name: deprecated202007getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-retrieves.deprecated202007getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/product-listings-json name: admin-api-2020-07-product-listings-json description: REST surface for admin-api-2020-07-product_listings.json. operations: - method: GET name: deprecated202007getproductlistings description: Shopify Retrieve Product Listings That Are Published To Your App call: shopify-retrieves.deprecated202007getproductlistings with: product_ids: rest.product_ids limit: rest.limit collection_id: rest.collection_id updated_at_min: rest.updated_at_min handle: rest.handle outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/product-listings/count-json name: admin-api-2020-07-product-listings-count-json description: REST surface for admin-api-2020-07-product_listings-count.json. operations: - method: GET name: deprecated202007getproductlistingscount description: Shopify Retrieve A Count Of Products That Are Published To Your App call: shopify-retrieves.deprecated202007getproductlistingscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/product-listings/product-ids-json name: admin-api-2020-07-product-listings-product-ids-json description: REST surface for admin-api-2020-07-product_listings-product_ids.json. operations: - method: GET name: deprecated202007getproductlistingsproductids description: Shopify Retrieve Product_ids That Are Published To Your App call: shopify-retrieves.deprecated202007getproductlistingsproductids with: limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/product-listings/product-listing-id-json name: admin-api-2020-07-product-listings-product-listing-id-json description: REST surface for admin-api-2020-07-product_listings-product_listing_id}.json. operations: - method: GET name: deprecated202007getproductlistingsparamproductlistingid description: Shopify Retrieve A Specific Product Listing That Is Published To Your App call: shopify-retrieves.deprecated202007getproductlistingsparamproductlistingid with: product_listing_id: rest.product_listing_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/products-json name: admin-api-2020-07-products-json description: REST surface for admin-api-2020-07-products.json. operations: - method: GET name: deprecated202007getproducts description: Shopify Retrieves A List Of Products call: shopify-retrieves.deprecated202007getproducts with: ids: rest.ids limit: rest.limit since_id: rest.since_id title: rest.title vendor: rest.vendor handle: rest.handle product_type: rest.product_type status: rest.status collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields presentment_currencies: rest.presentment_currencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/products/count-json name: admin-api-2020-07-products-count-json description: REST surface for admin-api-2020-07-products-count.json. operations: - method: GET name: deprecated202007getproductscount description: Shopify Retrieves A Count Of Products call: shopify-retrieves.deprecated202007getproductscount with: vendor: rest.vendor product_type: rest.product_type collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/products/product-id-json name: admin-api-2020-07-products-product-id-json description: REST surface for admin-api-2020-07-products-product_id}.json. operations: - method: GET name: deprecated202007getproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-retrieves.deprecated202007getproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/redirects-json name: admin-api-2020-07-redirects-json description: REST surface for admin-api-2020-07-redirects.json. operations: - method: GET name: deprecated202007getredirects description: Shopify Retrieves A List Of Url Redirects call: shopify-retrieves.deprecated202007getredirects with: limit: rest.limit since_id: rest.since_id path: rest.path target: rest.target fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/redirects/count-json name: admin-api-2020-07-redirects-count-json description: REST surface for admin-api-2020-07-redirects-count.json. operations: - method: GET name: deprecated202007getredirectscount description: Shopify Retrieves A Count Of Url Redirects call: shopify-retrieves.deprecated202007getredirectscount with: path: rest.path target: rest.target outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/redirects/redirect-id-json name: admin-api-2020-07-redirects-redirect-id-json description: REST surface for admin-api-2020-07-redirects-redirect_id}.json. operations: - method: GET name: deprecated202007getredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-retrieves.deprecated202007getredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/script-tags-json name: admin-api-2020-07-script-tags-json description: REST surface for admin-api-2020-07-script_tags.json. operations: - method: GET name: deprecated202007getscripttags description: Shopify Retrieves A List Of All Script Tags call: shopify-retrieves.deprecated202007getscripttags with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max src: rest.src fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/script-tags/count-json name: admin-api-2020-07-script-tags-count-json description: REST surface for admin-api-2020-07-script_tags-count.json. operations: - method: GET name: deprecated202007getscripttagscount description: Shopify Retrieves A Count Of All Script Tags call: shopify-retrieves.deprecated202007getscripttagscount with: src: rest.src outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/script-tags/script-tag-id-json name: admin-api-2020-07-script-tags-script-tag-id-json description: REST surface for admin-api-2020-07-script_tags-script_tag_id}.json. operations: - method: GET name: deprecated202007getscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-retrieves.deprecated202007getscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/shop-json name: admin-api-2020-07-shop-json description: REST surface for admin-api-2020-07-shop.json. operations: - method: GET name: deprecated202007getshop description: Shopify Retrieves The Shop's Configuration call: shopify-retrieves.deprecated202007getshop with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/shopify-payments/balance-json name: admin-api-2020-07-shopify-payments-balance-json description: REST surface for admin-api-2020-07-shopify_payments-balance.json. operations: - method: GET name: deprecated202007getshopifypaymentsbalance description: Shopify Retrieves The Account's Current Balance call: shopify-retrieves.deprecated202007getshopifypaymentsbalance outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/shopify-payments/payouts-json name: admin-api-2020-07-shopify-payments-payouts-json description: REST surface for admin-api-2020-07-shopify_payments-payouts.json. operations: - method: GET name: deprecated202007getshopifypaymentspayouts description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date call: shopify-retrieves.deprecated202007getshopifypaymentspayouts with: since_id: rest.since_id last_id: rest.last_id date_min: rest.date_min date_max: rest.date_max date: rest.date status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/shopify-payments/payouts/payout-id-json name: admin-api-2020-07-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-2020-07-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: deprecated202007getshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-retrieves.deprecated202007getshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/smart-collections-json name: admin-api-2020-07-smart-collections-json description: REST surface for admin-api-2020-07-smart_collections.json. operations: - method: GET name: deprecated202007getsmartcollections description: Shopify Retrieves A List Of Smart Collections call: shopify-retrieves.deprecated202007getsmartcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/smart-collections/count-json name: admin-api-2020-07-smart-collections-count-json description: REST surface for admin-api-2020-07-smart_collections-count.json. operations: - method: GET name: deprecated202007getsmartcollectionscount description: Shopify Retrieves A Count Of Smart Collections call: shopify-retrieves.deprecated202007getsmartcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/smart-collections/smart-collection-id-json name: admin-api-2020-07-smart-collections-smart-collection-id-json description: REST surface for admin-api-2020-07-smart_collections-smart_collection_id}.json. operations: - method: GET name: deprecated202007getsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-retrieves.deprecated202007getsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/tender-transactions-json name: admin-api-2020-07-tender-transactions-json description: REST surface for admin-api-2020-07-tender_transactions.json. operations: - method: GET name: deprecated202007gettendertransactions description: Shopify Retrieves A List Of Tender Transactions call: shopify-retrieves.deprecated202007gettendertransactions with: limit: rest.limit since_id: rest.since_id processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max processed_at: rest.processed_at order: rest.order outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/themes-json name: admin-api-2020-07-themes-json description: REST surface for admin-api-2020-07-themes.json. operations: - method: GET name: deprecated202007getthemes description: Shopify Retrieves A List Of Themes call: shopify-retrieves.deprecated202007getthemes with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/themes/theme-id-json name: admin-api-2020-07-themes-theme-id-json description: REST surface for admin-api-2020-07-themes-theme_id}.json. operations: - method: GET name: deprecated202007getthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-retrieves.deprecated202007getthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/themes/{theme-id}/assets-json name: admin-api-2020-07-themes-theme-id-assets-json description: REST surface for admin-api-2020-07-themes-theme_id-assets.json. operations: - method: GET name: deprecated202007getthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-retrieves.deprecated202007getthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/users-json name: admin-api-2020-07-users-json description: REST surface for admin-api-2020-07-users.json. operations: - method: GET name: deprecated202007getusers description: Shopify Retrieves A List Of All Users call: shopify-retrieves.deprecated202007getusers with: limit: rest.limit page_info: rest.page_info outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/users/current-json name: admin-api-2020-07-users-current-json description: REST surface for admin-api-2020-07-users-current.json. operations: - method: GET name: deprecated202007getuserscurrent description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request call: shopify-retrieves.deprecated202007getuserscurrent outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/users/user-id-json name: admin-api-2020-07-users-user-id-json description: REST surface for admin-api-2020-07-users-user_id}.json. operations: - method: GET name: deprecated202007getusersparamuserid description: Shopify Retrieves A Single User call: shopify-retrieves.deprecated202007getusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/webhooks-json name: admin-api-2020-07-webhooks-json description: REST surface for admin-api-2020-07-webhooks.json. operations: - method: GET name: deprecated202007getwebhooks description: Shopify Retrieves A List Of Webhooks call: shopify-retrieves.deprecated202007getwebhooks with: address: rest.address created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id topic: rest.topic updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/webhooks/count-json name: admin-api-2020-07-webhooks-count-json description: REST surface for admin-api-2020-07-webhooks-count.json. operations: - method: GET name: deprecated202007getwebhookscount description: Shopify Retrieves A Count Of Existing Webhook Subscriptions call: shopify-retrieves.deprecated202007getwebhookscount with: address: rest.address topic: rest.topic outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/webhooks/webhook-id-json name: admin-api-2020-07-webhooks-webhook-id-json description: REST surface for admin-api-2020-07-webhooks-webhook_id}.json. operations: - method: GET name: deprecated202007getwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-retrieves.deprecated202007getwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/articles/authors-json name: admin-api-2020-10-articles-authors-json description: REST surface for admin-api-2020-10-articles-authors.json. operations: - method: GET name: getarticlesauthors description: Shopify Retrieves A List All Of Article Authors call: shopify-retrieves.getarticlesauthors outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/articles/tags-json name: admin-api-2020-10-articles-tags-json description: REST surface for admin-api-2020-10-articles-tags.json. operations: - method: GET name: getarticlestags description: Shopify Retrieves A List Of All The Tags call: shopify-retrieves.getarticlestags with: limit: rest.limit popular: rest.popular outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/assigned-fulfillment-orders-json name: admin-api-2020-10-assigned-fulfillment-orders-json description: REST surface for admin-api-2020-10-assigned_fulfillment_orders.json. operations: - method: GET name: getassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-retrieves.getassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/blogs/{blog-id}/articles-json name: admin-api-2020-10-blogs-blog-id-articles-json description: REST surface for admin-api-2020-10-blogs-blog_id-articles.json. operations: - method: GET name: getblogsparamblogidarticles description: Shopify Retrieves A List Of All Articles From A Blog call: shopify-retrieves.getblogsparamblogidarticles with: blog_id: rest.blog_id limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status handle: rest.handle tag: rest.tag author: rest.author fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/blogs/{blog-id}/articles/count-json name: admin-api-2020-10-blogs-blog-id-articles-count-json description: REST surface for admin-api-2020-10-blogs-blog_id-articles-count.json. operations: - method: GET name: getblogsparamblogidarticlescount description: Shopify Retrieves A Count Of All Articles From A Blog call: shopify-retrieves.getblogsparamblogidarticlescount with: blog_id: rest.blog_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/blogs/{blog-id}/articles/article-id-json name: admin-api-2020-10-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-2020-10-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: getblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-retrieves.getblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/carrier-services-json name: admin-api-2020-10-carrier-services-json description: REST surface for admin-api-2020-10-carrier_services.json. operations: - method: GET name: getcarrierservices description: Shopify Retrieves A List Of Carrier Services call: shopify-retrieves.getcarrierservices outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/carrier-services/carrier-service-id-json name: admin-api-2020-10-carrier-services-carrier-service-id-json description: REST surface for admin-api-2020-10-carrier_services-carrier_service_id}.json. operations: - method: GET name: getcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-retrieves.getcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/checkouts/count-json name: admin-api-2020-10-checkouts-count-json description: REST surface for admin-api-2020-10-checkouts-count.json. operations: - method: GET name: getcheckoutscount description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days call: shopify-retrieves.getcheckoutscount with: since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/checkouts/token-json name: admin-api-2020-10-checkouts-token-json description: REST surface for admin-api-2020-10-checkouts-token}.json. operations: - method: GET name: getcheckoutsparamtoken description: Shopify Retrieves A Checkout call: shopify-retrieves.getcheckoutsparamtoken with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/checkouts/{token}/payments-json name: admin-api-2020-10-checkouts-token-payments-json description: REST surface for admin-api-2020-10-checkouts-token-payments.json. operations: - method: GET name: getcheckoutsparamtokenpayments description: Shopify Retrieves A List Of Payments On A Particular Checkout call: shopify-retrieves.getcheckoutsparamtokenpayments with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/checkouts/{token}/payments/payment-id-json name: admin-api-2020-10-checkouts-token-payments-payment-id-json description: REST surface for admin-api-2020-10-checkouts-token-payments-payment_id}.json. operations: - method: GET name: getcheckoutsparamtokenpaymentsparampaymentid description: Shopify Retrieves The Payment Information For An Existing Payment call: shopify-retrieves.getcheckoutsparamtokenpaymentsparampaymentid with: token: rest.token payment_id: rest.payment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/checkouts/{token}/shipping-rates-json name: admin-api-2020-10-checkouts-token-shipping-rates-json description: REST surface for admin-api-2020-10-checkouts-token-shipping_rates.json. operations: - method: GET name: getcheckoutsparamtokenshippingrates description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout call: shopify-retrieves.getcheckoutsparamtokenshippingrates with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/collection-listings-json name: admin-api-2020-10-collection-listings-json description: REST surface for admin-api-2020-10-collection_listings.json. operations: - method: GET name: getcollectionlistings description: Shopify Retrieve Collection Listings That Are Published To Your App call: shopify-retrieves.getcollectionlistings with: limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/collection-listings/collection-listing-id-json name: admin-api-2020-10-collection-listings-collection-listing-id-json description: REST surface for admin-api-2020-10-collection_listings-collection_listing_id}.json. operations: - method: GET name: getcollectionlistingsparamcollectionlistingid description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App call: shopify-retrieves.getcollectionlistingsparamcollectionlistingid with: collection_listing_id: rest.collection_listing_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/collection-listings/{collection-listing-id}/product-ids-json name: admin-api-2020-10-collection-listings-collection-listing-id-product-ids-json description: REST surface for admin-api-2020-10-collection_listings-collection_listing_id-product_ids.json. operations: - method: GET name: getcollectionlistingsparamcollectionlistingidproductids description: Shopify Retrieve Product_ids That Are Published To A Collection_id call: shopify-retrieves.getcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: rest.collection_listing_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/collections/collection-id-json name: admin-api-2020-10-collections-collection-id-json description: REST surface for admin-api-2020-10-collections-collection_id}.json. operations: - method: GET name: getcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-retrieves.getcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/collections/{collection-id}/products-json name: admin-api-2020-10-collections-collection-id-products-json description: REST surface for admin-api-2020-10-collections-collection_id-products.json. operations: - method: GET name: getcollectionsparamcollectionidproducts description: Shopify Retrieve A List Of Products Belonging To A Collection call: shopify-retrieves.getcollectionsparamcollectionidproducts with: collection_id: rest.collection_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/collects-json name: admin-api-2020-10-collects-json description: REST surface for admin-api-2020-10-collects.json. operations: - method: GET name: getcollects description: Shopify Retrieves A List Of Collects call: shopify-retrieves.getcollects with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/collects/count-json name: admin-api-2020-10-collects-count-json description: REST surface for admin-api-2020-10-collects-count.json. operations: - method: GET name: getcollectscount description: Shopify Retrieves A Count Of Collects call: shopify-retrieves.getcollectscount with: collection_id: rest.collection_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/collects/collect-id-json name: admin-api-2020-10-collects-collect-id-json description: REST surface for admin-api-2020-10-collects-collect_id}.json. operations: - method: GET name: getcollectsparamcollectid description: Shopify Retrieves A Specific Collect By Its Id call: shopify-retrieves.getcollectsparamcollectid with: collect_id: rest.collect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/countries-json name: admin-api-2020-10-countries-json description: REST surface for admin-api-2020-10-countries.json. operations: - method: GET name: getcountries description: Shopify Retrieves A List Of Countries call: shopify-retrieves.getcountries with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/countries/count-json name: admin-api-2020-10-countries-count-json description: REST surface for admin-api-2020-10-countries-count.json. operations: - method: GET name: getcountriescount description: Shopify Retrieves A Count Of Countries call: shopify-retrieves.getcountriescount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/countries/country-id-json name: admin-api-2020-10-countries-country-id-json description: REST surface for admin-api-2020-10-countries-country_id}.json. operations: - method: GET name: getcountriesparamcountryid description: Shopify Retrieves A Specific County call: shopify-retrieves.getcountriesparamcountryid with: country_id: rest.country_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/countries/{country-id}/provinces-json name: admin-api-2020-10-countries-country-id-provinces-json description: REST surface for admin-api-2020-10-countries-country_id-provinces.json. operations: - method: GET name: getcountriesparamcountryidprovinces description: Shopify Retrieves A List Of Provinces call: shopify-retrieves.getcountriesparamcountryidprovinces with: country_id: rest.country_id since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/countries/{country-id}/provinces/count-json name: admin-api-2020-10-countries-country-id-provinces-count-json description: REST surface for admin-api-2020-10-countries-country_id-provinces-count.json. operations: - method: GET name: getcountriesparamcountryidprovincescount description: Shopify Retrieves A Count Of Provinces For A Country call: shopify-retrieves.getcountriesparamcountryidprovincescount with: country_id: rest.country_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/countries/{country-id}/provinces/province-id-json name: admin-api-2020-10-countries-country-id-provinces-province-id-json description: REST surface for admin-api-2020-10-countries-country_id-provinces-province_id}.json. operations: - method: GET name: getcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-retrieves.getcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/currencies-json name: admin-api-2020-10-currencies-json description: REST surface for admin-api-2020-10-currencies.json. operations: - method: GET name: getcurrencies description: Shopify Retrieves A List Of Currencies Enabled On A Shop call: shopify-retrieves.getcurrencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/custom-collections-json name: admin-api-2020-10-custom-collections-json description: REST surface for admin-api-2020-10-custom_collections.json. operations: - method: GET name: getcustomcollections description: Shopify Retrieves A List Of Custom Collections call: shopify-retrieves.getcustomcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/custom-collections/count-json name: admin-api-2020-10-custom-collections-count-json description: REST surface for admin-api-2020-10-custom_collections-count.json. operations: - method: GET name: getcustomcollectionscount description: Shopify Retrieves A Count Of Custom Collections call: shopify-retrieves.getcustomcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/custom-collections/custom-collection-id-json name: admin-api-2020-10-custom-collections-custom-collection-id-json description: REST surface for admin-api-2020-10-custom_collections-custom_collection_id}.json. operations: - method: GET name: getcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-retrieves.getcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customer-saved-searches-json name: admin-api-2020-10-customer-saved-searches-json description: REST surface for admin-api-2020-10-customer_saved_searches.json. operations: - method: GET name: getcustomersavedsearches description: Shopify Retrieves A List Of Customer Saved Searches call: shopify-retrieves.getcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customer-saved-searches/count-json name: admin-api-2020-10-customer-saved-searches-count-json description: REST surface for admin-api-2020-10-customer_saved_searches-count.json. operations: - method: GET name: getcustomersavedsearchescount description: Shopify Retrieves A Count Of All Customer Saved Searches call: shopify-retrieves.getcustomersavedsearchescount with: since_id: rest.since_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customer-saved-searches/customer-saved-search-id-json name: admin-api-2020-10-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-2020-10-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: getcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-retrieves.getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customer-saved-searches/{customer-saved-search-id}/customers-json name: admin-api-2020-10-customer-saved-searches-customer-saved-search-id-customers-jso description: REST surface for admin-api-2020-10-customer_saved_searches-customer_saved_search_id-customers.jso. operations: - method: GET name: getcustomersavedsearchesparamcustomersavedsearchidcustomers description: Shopify Retrieves All Customers Returned By A Customer Saved Search call: shopify-retrieves.getcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: rest.customer_saved_search_id order: rest.order limit: rest.limit fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customers/{customer-id}/addresses-json name: admin-api-2020-10-customers-customer-id-addresses-json description: REST surface for admin-api-2020-10-customers-customer_id-addresses.json. operations: - method: GET name: getcustomersparamcustomeridaddresses description: Shopify Retrieves A List Of Addresses For A Customer call: shopify-retrieves.getcustomersparamcustomeridaddresses with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customers/{customer-id}/addresses/address-id-json name: admin-api-2020-10-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-2020-10-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: getcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-retrieves.getcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/discount-codes/lookup-json name: admin-api-2020-10-discount-codes-lookup-json description: REST surface for admin-api-2020-10-discount_codes-lookup.json. operations: - method: GET name: getdiscountcodeslookup description: Shopify Retrieves The Location Of A Discount Code call: shopify-retrieves.getdiscountcodeslookup with: code: rest.code outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/events-json name: admin-api-2020-10-events-json description: REST surface for admin-api-2020-10-events.json. operations: - method: GET name: getevents description: Shopify Retrieves A List Of Events call: shopify-retrieves.getevents with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max filter: rest.filter verb: rest.verb fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/events/count-json name: admin-api-2020-10-events-count-json description: REST surface for admin-api-2020-10-events-count.json. operations: - method: GET name: geteventscount description: Shopify Retrieves A Count Of Events call: shopify-retrieves.geteventscount with: created_at_min: rest.created_at_min created_at_max: rest.created_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/events/event-id-json name: admin-api-2020-10-events-event-id-json description: REST surface for admin-api-2020-10-events-event_id}.json. operations: - method: GET name: geteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-retrieves.geteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/fulfillment-orders/fulfillment-order-id-json name: admin-api-2020-10-fulfillment-orders-fulfillment-order-id-json description: REST surface for admin-api-2020-10-fulfillment_orders-fulfillment_order_id}.json. operations: - method: GET name: getfulfillmentordersparamfulfillmentorderid description: Shopify Retrieves A Specific Fulfillment Order call: shopify-retrieves.getfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/fulfillment-orders/{fulfillment-order-id}/fulfillments-json name: admin-api-2020-10-fulfillment-orders-fulfillment-order-id-fulfillments-json description: REST surface for admin-api-2020-10-fulfillment_orders-fulfillment_order_id-fulfillments.json. operations: - method: GET name: getfulfillmentordersparamfulfillmentorderidfulfillments description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order call: shopify-retrieves.getfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/fulfillment-orders/{fulfillment-order-id}/locations-for-move-json name: admin-api-2020-10-fulfillment-orders-fulfillment-order-id-locations-for-move-jso description: REST surface for admin-api-2020-10-fulfillment_orders-fulfillment_order_id-locations_for_move.jso. operations: - method: GET name: getfulfillmentordersparamfulfillmentorderidlocationsformove description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To call: shopify-retrieves.getfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/gift-cards-json name: admin-api-2020-10-gift-cards-json description: REST surface for admin-api-2020-10-gift_cards.json. operations: - method: GET name: getgiftcards description: Shopify Retrieves A List Of Gift Cards call: shopify-retrieves.getgiftcards with: status: rest.status limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/gift-cards/count-json name: admin-api-2020-10-gift-cards-count-json description: REST surface for admin-api-2020-10-gift_cards-count.json. operations: - method: GET name: getgiftcardscount description: Shopify Retrieves A Count Of Gift Cards call: shopify-retrieves.getgiftcardscount with: status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/gift-cards/gift-card-id-json name: admin-api-2020-10-gift-cards-gift-card-id-json description: REST surface for admin-api-2020-10-gift_cards-gift_card_id}.json. operations: - method: GET name: getgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-retrieves.getgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/inventory-items-json name: admin-api-2020-10-inventory-items-json description: REST surface for admin-api-2020-10-inventory_items.json. operations: - method: GET name: getinventoryitems description: Shopify Retrieves A List Of Inventory Items call: shopify-retrieves.getinventoryitems with: ? "ids\n required" : "rest.ids\n required" limit: rest.limit ids: rest.ids outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/inventory-items/inventory-item-id-json name: admin-api-2020-10-inventory-items-inventory-item-id-json description: REST surface for admin-api-2020-10-inventory_items-inventory_item_id}.json. operations: - method: GET name: getinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-retrieves.getinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/inventory-levels-json name: admin-api-2020-10-inventory-levels-json description: REST surface for admin-api-2020-10-inventory_levels.json. operations: - method: GET name: getinventorylevels description: Shopify Retrieves A List Of Inventory Levels call: shopify-retrieves.getinventorylevels with: inventory_item_ids: rest.inventory_item_ids location_ids: rest.location_ids limit: rest.limit updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/locations-json name: admin-api-2020-10-locations-json description: REST surface for admin-api-2020-10-locations.json. operations: - method: GET name: getlocations description: Shopify Retrieves A List Of Locations call: shopify-retrieves.getlocations outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/locations/count-json name: admin-api-2020-10-locations-count-json description: REST surface for admin-api-2020-10-locations-count.json. operations: - method: GET name: getlocationscount description: Shopify Retrieves A Count Of Locations call: shopify-retrieves.getlocationscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/locations/location-id-json name: admin-api-2020-10-locations-location-id-json description: REST surface for admin-api-2020-10-locations-location_id}.json. operations: - method: GET name: getlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-retrieves.getlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/locations/{location-id}/inventory-levels-json name: admin-api-2020-10-locations-location-id-inventory-levels-json description: REST surface for admin-api-2020-10-locations-location_id-inventory_levels.json. operations: - method: GET name: getlocationsparamlocationidinventorylevels description: Shopify Retrieves A List Of Inventory Levels For A Location call: shopify-retrieves.getlocationsparamlocationidinventorylevels with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/metafields-json name: admin-api-2020-10-metafields-json description: REST surface for admin-api-2020-10-metafields.json. operations: - method: GET name: getmetafields description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource call: shopify-retrieves.getmetafields with: metafield[owner_id]: rest.metafield[owner_id] metafield[owner_resource]: rest.metafield[owner_resource] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/metafields/count-json name: admin-api-2020-10-metafields-count-json description: REST surface for admin-api-2020-10-metafields-count.json. operations: - method: GET name: getmetafieldscount description: Shopify Retrieves A Count Of A Resource's Metafields call: shopify-retrieves.getmetafieldscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/metafields/metafield-id-json name: admin-api-2020-10-metafields-metafield-id-json description: REST surface for admin-api-2020-10-metafields-metafield_id}.json. operations: - method: GET name: getmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-retrieves.getmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/fulfillment-orders-json name: admin-api-2020-10-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-2020-10-orders-order_id-fulfillment_orders.json. operations: - method: GET name: getordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-retrieves.getordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/fulfillments-json name: admin-api-2020-10-orders-order-id-fulfillments-json description: REST surface for admin-api-2020-10-orders-order_id-fulfillments.json. operations: - method: GET name: getordersparamorderidfulfillments description: Shopify Retrieves Fulfillments Associated With An Order call: shopify-retrieves.getordersparamorderidfulfillments with: order_id: rest.order_id created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id updated_at_max: rest.updated_at_max updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/fulfillments/count-json name: admin-api-2020-10-orders-order-id-fulfillments-count-json description: REST surface for admin-api-2020-10-orders-order_id-fulfillments-count.json. operations: - method: GET name: getordersparamorderidfulfillmentscount description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order call: shopify-retrieves.getordersparamorderidfulfillmentscount with: order_id: rest.order_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/fulfillments/fulfillment-id-json name: admin-api-2020-10-orders-order-id-fulfillments-fulfillment-id-json description: REST surface for admin-api-2020-10-orders-order_id-fulfillments-fulfillment_id}.json. operations: - method: GET name: getordersparamorderidfulfillmentsparamfulfillmentid description: Shopify Retrieve A Specific Fulfillment call: shopify-retrieves.getordersparamorderidfulfillmentsparamfulfillmentid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/fulfillments/{fulfillment-id}/events-json name: admin-api-2020-10-orders-order-id-fulfillments-fulfillment-id-events-json description: REST surface for admin-api-2020-10-orders-order_id-fulfillments-fulfillment_id-events.json. operations: - method: GET name: getordersparamorderidfulfillmentsparamfulfillmentidevents description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment call: shopify-retrieves.getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/fulfillments/{fulfillment-id}/events/event-id-json name: admin-api-2020-10-orders-order-id-fulfillments-fulfillment-id-events-event-id-j description: REST surface for admin-api-2020-10-orders-order_id-fulfillments-fulfillment_id-events-event_id}.j. operations: - method: GET name: getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid description: Shopify Retrieves A Specific Fulfillment Event call: shopify-retrieves.getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id event_id: rest.event_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/refunds-json name: admin-api-2020-10-orders-order-id-refunds-json description: REST surface for admin-api-2020-10-orders-order_id-refunds.json. operations: - method: GET name: getordersparamorderidrefunds description: Shopify Retrieves A List Of Refunds For An Order call: shopify-retrieves.getordersparamorderidrefunds with: order_id: rest.order_id limit: rest.limit fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/refunds/refund-id-json name: admin-api-2020-10-orders-order-id-refunds-refund-id-json description: REST surface for admin-api-2020-10-orders-order_id-refunds-refund_id}.json. operations: - method: GET name: getordersparamorderidrefundsparamrefundid description: Shopify Retrieves A Specific Refund call: shopify-retrieves.getordersparamorderidrefundsparamrefundid with: order_id: rest.order_id refund_id: rest.refund_id fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/risks-json name: admin-api-2020-10-orders-order-id-risks-json description: REST surface for admin-api-2020-10-orders-order_id-risks.json. operations: - method: GET name: getordersparamorderidrisks description: Shopify Retrieves A List Of All Order Risks For An Order call: shopify-retrieves.getordersparamorderidrisks with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/risks/risk-id-json name: admin-api-2020-10-orders-order-id-risks-risk-id-json description: REST surface for admin-api-2020-10-orders-order_id-risks-risk_id}.json. operations: - method: GET name: getordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-retrieves.getordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/policies-json name: admin-api-2020-10-policies-json description: REST surface for admin-api-2020-10-policies.json. operations: - method: GET name: getpolicies description: Shopify Retrieves A List Of The Shop's Policies call: shopify-retrieves.getpolicies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/price-rules/{price-rule-id}/batch/batch-id-json name: admin-api-2020-10-price-rules-price-rule-id-batch-batch-id-json description: REST surface for admin-api-2020-10-price_rules-price_rule_id-batch-batch_id}.json. operations: - method: GET name: getpricerulesparampriceruleidbatchparambatchid description: Shopify Retrieves A Discount Code Creation Job call: shopify-retrieves.getpricerulesparampriceruleidbatchparambatchid with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/price-rules/{price-rule-id}/batch/{batch-id}/discount-codes-json name: admin-api-2020-10-price-rules-price-rule-id-batch-batch-id-discount-codes-json description: REST surface for admin-api-2020-10-price_rules-price_rule_id-batch-batch_id-discount_codes.json. operations: - method: GET name: getpricerulesparampriceruleidbatchparambatchiddiscountcodes description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job call: shopify-retrieves.getpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/price-rules/{price-rule-id}/discount-codes-json name: admin-api-2020-10-price-rules-price-rule-id-discount-codes-json description: REST surface for admin-api-2020-10-price_rules-price_rule_id-discount_codes.json. operations: - method: GET name: getpricerulesparampriceruleiddiscountcodes description: Shopify Retrieve A List Of Discount Codes call: shopify-retrieves.getpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-2020-10-price-rules-price-rule-id-discount-codes-discount-code-id-jso description: REST surface for admin-api-2020-10-price_rules-price_rule_id-discount_codes-discount_code_id}.jso. operations: - method: GET name: getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-retrieves.getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/products-json name: admin-api-2020-10-products-json description: REST surface for admin-api-2020-10-products.json. operations: - method: GET name: getproducts description: Shopify Retrieves A List Of Products call: shopify-retrieves.getproducts with: ids: rest.ids limit: rest.limit since_id: rest.since_id title: rest.title vendor: rest.vendor handle: rest.handle product_type: rest.product_type status: rest.status collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields presentment_currencies: rest.presentment_currencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/products/count-json name: admin-api-2020-10-products-count-json description: REST surface for admin-api-2020-10-products-count.json. operations: - method: GET name: getproductscount description: Shopify Retrieves A Count Of Products call: shopify-retrieves.getproductscount with: vendor: rest.vendor product_type: rest.product_type collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/products/product-id-json name: admin-api-2020-10-products-product-id-json description: REST surface for admin-api-2020-10-products-product_id}.json. operations: - method: GET name: getproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-retrieves.getproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/redirects-json name: admin-api-2020-10-redirects-json description: REST surface for admin-api-2020-10-redirects.json. operations: - method: GET name: getredirects description: Shopify Retrieves A List Of Url Redirects call: shopify-retrieves.getredirects with: limit: rest.limit since_id: rest.since_id path: rest.path target: rest.target fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/redirects/count-json name: admin-api-2020-10-redirects-count-json description: REST surface for admin-api-2020-10-redirects-count.json. operations: - method: GET name: getredirectscount description: Shopify Retrieves A Count Of Url Redirects call: shopify-retrieves.getredirectscount with: path: rest.path target: rest.target outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/redirects/redirect-id-json name: admin-api-2020-10-redirects-redirect-id-json description: REST surface for admin-api-2020-10-redirects-redirect_id}.json. operations: - method: GET name: getredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-retrieves.getredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/script-tags-json name: admin-api-2020-10-script-tags-json description: REST surface for admin-api-2020-10-script_tags.json. operations: - method: GET name: getscripttags description: Shopify Retrieves A List Of All Script Tags call: shopify-retrieves.getscripttags with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max src: rest.src fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/script-tags/count-json name: admin-api-2020-10-script-tags-count-json description: REST surface for admin-api-2020-10-script_tags-count.json. operations: - method: GET name: getscripttagscount description: Shopify Retrieves A Count Of All Script Tags call: shopify-retrieves.getscripttagscount with: src: rest.src outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/script-tags/script-tag-id-json name: admin-api-2020-10-script-tags-script-tag-id-json description: REST surface for admin-api-2020-10-script_tags-script_tag_id}.json. operations: - method: GET name: getscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-retrieves.getscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/shop-json name: admin-api-2020-10-shop-json description: REST surface for admin-api-2020-10-shop.json. operations: - method: GET name: getshop description: Shopify Retrieves The Shop's Configuration call: shopify-retrieves.getshop with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/shopify-payments/balance-json name: admin-api-2020-10-shopify-payments-balance-json description: REST surface for admin-api-2020-10-shopify_payments-balance.json. operations: - method: GET name: getshopifypaymentsbalance description: Shopify Retrieves The Account's Current Balance call: shopify-retrieves.getshopifypaymentsbalance outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/shopify-payments/payouts-json name: admin-api-2020-10-shopify-payments-payouts-json description: REST surface for admin-api-2020-10-shopify_payments-payouts.json. operations: - method: GET name: getshopifypaymentspayouts description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date call: shopify-retrieves.getshopifypaymentspayouts with: since_id: rest.since_id last_id: rest.last_id date_min: rest.date_min date_max: rest.date_max date: rest.date status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/shopify-payments/payouts/payout-id-json name: admin-api-2020-10-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-2020-10-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: getshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-retrieves.getshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/smart-collections-json name: admin-api-2020-10-smart-collections-json description: REST surface for admin-api-2020-10-smart_collections.json. operations: - method: GET name: getsmartcollections description: Shopify Retrieves A List Of Smart Collections call: shopify-retrieves.getsmartcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/smart-collections/count-json name: admin-api-2020-10-smart-collections-count-json description: REST surface for admin-api-2020-10-smart_collections-count.json. operations: - method: GET name: getsmartcollectionscount description: Shopify Retrieves A Count Of Smart Collections call: shopify-retrieves.getsmartcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/smart-collections/smart-collection-id-json name: admin-api-2020-10-smart-collections-smart-collection-id-json description: REST surface for admin-api-2020-10-smart_collections-smart_collection_id}.json. operations: - method: GET name: getsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-retrieves.getsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/tender-transactions-json name: admin-api-2020-10-tender-transactions-json description: REST surface for admin-api-2020-10-tender_transactions.json. operations: - method: GET name: gettendertransactions description: Shopify Retrieves A List Of Tender Transactions call: shopify-retrieves.gettendertransactions with: limit: rest.limit since_id: rest.since_id processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max processed_at: rest.processed_at order: rest.order outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/themes-json name: admin-api-2020-10-themes-json description: REST surface for admin-api-2020-10-themes.json. operations: - method: GET name: getthemes description: Shopify Retrieves A List Of Themes call: shopify-retrieves.getthemes with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/themes/theme-id-json name: admin-api-2020-10-themes-theme-id-json description: REST surface for admin-api-2020-10-themes-theme_id}.json. operations: - method: GET name: getthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-retrieves.getthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/themes/{theme-id}/assets-json name: admin-api-2020-10-themes-theme-id-assets-json description: REST surface for admin-api-2020-10-themes-theme_id-assets.json. operations: - method: GET name: getthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-retrieves.getthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/users-json name: admin-api-2020-10-users-json description: REST surface for admin-api-2020-10-users.json. operations: - method: GET name: getusers description: Shopify Retrieves A List Of All Users call: shopify-retrieves.getusers with: limit: rest.limit page_info: rest.page_info outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/users/current-json name: admin-api-2020-10-users-current-json description: REST surface for admin-api-2020-10-users-current.json. operations: - method: GET name: getuserscurrent description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request call: shopify-retrieves.getuserscurrent outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/users/user-id-json name: admin-api-2020-10-users-user-id-json description: REST surface for admin-api-2020-10-users-user_id}.json. operations: - method: GET name: getusersparamuserid description: Shopify Retrieves A Single User call: shopify-retrieves.getusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/webhooks-json name: admin-api-2020-10-webhooks-json description: REST surface for admin-api-2020-10-webhooks.json. operations: - method: GET name: getwebhooks description: Shopify Retrieves A List Of Webhooks call: shopify-retrieves.getwebhooks with: address: rest.address created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id topic: rest.topic updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/webhooks/count-json name: admin-api-2020-10-webhooks-count-json description: REST surface for admin-api-2020-10-webhooks-count.json. operations: - method: GET name: getwebhookscount description: Shopify Retrieves A Count Of Existing Webhook Subscriptions call: shopify-retrieves.getwebhookscount with: address: rest.address topic: rest.topic outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/webhooks/webhook-id-json name: admin-api-2020-10-webhooks-webhook-id-json description: REST surface for admin-api-2020-10-webhooks-webhook_id}.json. operations: - method: GET name: getwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-retrieves.getwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/articles/authors-json name: admin-api-2021-01-articles-authors-json description: REST surface for admin-api-2021-01-articles-authors.json. operations: - method: GET name: deprecated202101getarticlesauthors description: Shopify Retrieves A List All Of Article Authors call: shopify-retrieves.deprecated202101getarticlesauthors outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/articles/tags-json name: admin-api-2021-01-articles-tags-json description: REST surface for admin-api-2021-01-articles-tags.json. operations: - method: GET name: deprecated202101getarticlestags description: Shopify Retrieves A List Of All The Tags call: shopify-retrieves.deprecated202101getarticlestags with: limit: rest.limit popular: rest.popular outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/assigned-fulfillment-orders-json name: admin-api-2021-01-assigned-fulfillment-orders-json description: REST surface for admin-api-2021-01-assigned_fulfillment_orders.json. operations: - method: GET name: deprecated202101getassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-retrieves.deprecated202101getassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/blogs/{blog-id}/articles-json name: admin-api-2021-01-blogs-blog-id-articles-json description: REST surface for admin-api-2021-01-blogs-blog_id-articles.json. operations: - method: GET name: deprecated202101getblogsparamblogidarticles description: Shopify Retrieves A List Of All Articles From A Blog call: shopify-retrieves.deprecated202101getblogsparamblogidarticles with: blog_id: rest.blog_id limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status handle: rest.handle tag: rest.tag author: rest.author fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/blogs/{blog-id}/articles/count-json name: admin-api-2021-01-blogs-blog-id-articles-count-json description: REST surface for admin-api-2021-01-blogs-blog_id-articles-count.json. operations: - method: GET name: deprecated202101getblogsparamblogidarticlescount description: Shopify Retrieves A Count Of All Articles From A Blog call: shopify-retrieves.deprecated202101getblogsparamblogidarticlescount with: blog_id: rest.blog_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/blogs/{blog-id}/articles/article-id-json name: admin-api-2021-01-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-2021-01-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: deprecated202101getblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-retrieves.deprecated202101getblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/carrier-services-json name: admin-api-2021-01-carrier-services-json description: REST surface for admin-api-2021-01-carrier_services.json. operations: - method: GET name: deprecated202101getcarrierservices description: Shopify Retrieves A List Of Carrier Services call: shopify-retrieves.deprecated202101getcarrierservices outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/carrier-services/carrier-service-id-json name: admin-api-2021-01-carrier-services-carrier-service-id-json description: REST surface for admin-api-2021-01-carrier_services-carrier_service_id}.json. operations: - method: GET name: deprecated202101getcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-retrieves.deprecated202101getcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/checkouts/count-json name: admin-api-2021-01-checkouts-count-json description: REST surface for admin-api-2021-01-checkouts-count.json. operations: - method: GET name: deprecated202101getcheckoutscount description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days call: shopify-retrieves.deprecated202101getcheckoutscount with: since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/checkouts/token-json name: admin-api-2021-01-checkouts-token-json description: REST surface for admin-api-2021-01-checkouts-token}.json. operations: - method: GET name: deprecated202101getcheckoutsparamtoken description: Shopify Retrieves A Checkout call: shopify-retrieves.deprecated202101getcheckoutsparamtoken with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/checkouts/{token}/payments-json name: admin-api-2021-01-checkouts-token-payments-json description: REST surface for admin-api-2021-01-checkouts-token-payments.json. operations: - method: GET name: deprecated202101getcheckoutsparamtokenpayments description: Shopify Retrieves A List Of Payments On A Particular Checkout call: shopify-retrieves.deprecated202101getcheckoutsparamtokenpayments with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/checkouts/{token}/payments/payment-id-json name: admin-api-2021-01-checkouts-token-payments-payment-id-json description: REST surface for admin-api-2021-01-checkouts-token-payments-payment_id}.json. operations: - method: GET name: deprecated202101getcheckoutsparamtokenpaymentsparampaymentid description: Shopify Retrieves The Payment Information For An Existing Payment call: shopify-retrieves.deprecated202101getcheckoutsparamtokenpaymentsparampaymentid with: token: rest.token payment_id: rest.payment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/checkouts/{token}/shipping-rates-json name: admin-api-2021-01-checkouts-token-shipping-rates-json description: REST surface for admin-api-2021-01-checkouts-token-shipping_rates.json. operations: - method: GET name: deprecated202101getcheckoutsparamtokenshippingrates description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout call: shopify-retrieves.deprecated202101getcheckoutsparamtokenshippingrates with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/collection-listings-json name: admin-api-2021-01-collection-listings-json description: REST surface for admin-api-2021-01-collection_listings.json. operations: - method: GET name: deprecated202101getcollectionlistings description: Shopify Retrieve Collection Listings That Are Published To Your App call: shopify-retrieves.deprecated202101getcollectionlistings with: limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/collection-listings/collection-listing-id-json name: admin-api-2021-01-collection-listings-collection-listing-id-json description: REST surface for admin-api-2021-01-collection_listings-collection_listing_id}.json. operations: - method: GET name: deprecated202101getcollectionlistingsparamcollectionlistingid description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App call: shopify-retrieves.deprecated202101getcollectionlistingsparamcollectionlistingid with: collection_listing_id: rest.collection_listing_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/collection-listings/{collection-listing-id}/product-ids-json name: admin-api-2021-01-collection-listings-collection-listing-id-product-ids-json description: REST surface for admin-api-2021-01-collection_listings-collection_listing_id-product_ids.json. operations: - method: GET name: deprecated202101getcollectionlistingsparamcollectionlistingidproductids description: Shopify Retrieve Product_ids That Are Published To A Collection_id call: shopify-retrieves.deprecated202101getcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: rest.collection_listing_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/collections/collection-id-json name: admin-api-2021-01-collections-collection-id-json description: REST surface for admin-api-2021-01-collections-collection_id}.json. operations: - method: GET name: deprecated202101getcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-retrieves.deprecated202101getcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/collections/{collection-id}/products-json name: admin-api-2021-01-collections-collection-id-products-json description: REST surface for admin-api-2021-01-collections-collection_id-products.json. operations: - method: GET name: deprecated202101getcollectionsparamcollectionidproducts description: Shopify Retrieve A List Of Products Belonging To A Collection call: shopify-retrieves.deprecated202101getcollectionsparamcollectionidproducts with: collection_id: rest.collection_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/collects-json name: admin-api-2021-01-collects-json description: REST surface for admin-api-2021-01-collects.json. operations: - method: GET name: deprecated202101getcollects description: Shopify Retrieves A List Of Collects call: shopify-retrieves.deprecated202101getcollects with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/collects/count-json name: admin-api-2021-01-collects-count-json description: REST surface for admin-api-2021-01-collects-count.json. operations: - method: GET name: deprecated202101getcollectscount description: Shopify Retrieves A Count Of Collects call: shopify-retrieves.deprecated202101getcollectscount with: collection_id: rest.collection_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/collects/collect-id-json name: admin-api-2021-01-collects-collect-id-json description: REST surface for admin-api-2021-01-collects-collect_id}.json. operations: - method: GET name: deprecated202101getcollectsparamcollectid description: Shopify Retrieves A Specific Collect By Its Id call: shopify-retrieves.deprecated202101getcollectsparamcollectid with: collect_id: rest.collect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/countries-json name: admin-api-2021-01-countries-json description: REST surface for admin-api-2021-01-countries.json. operations: - method: GET name: deprecated202101getcountries description: Shopify Retrieves A List Of Countries call: shopify-retrieves.deprecated202101getcountries with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/countries/count-json name: admin-api-2021-01-countries-count-json description: REST surface for admin-api-2021-01-countries-count.json. operations: - method: GET name: deprecated202101getcountriescount description: Shopify Retrieves A Count Of Countries call: shopify-retrieves.deprecated202101getcountriescount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/countries/country-id-json name: admin-api-2021-01-countries-country-id-json description: REST surface for admin-api-2021-01-countries-country_id}.json. operations: - method: GET name: deprecated202101getcountriesparamcountryid description: Shopify Retrieves A Specific County call: shopify-retrieves.deprecated202101getcountriesparamcountryid with: country_id: rest.country_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/countries/{country-id}/provinces-json name: admin-api-2021-01-countries-country-id-provinces-json description: REST surface for admin-api-2021-01-countries-country_id-provinces.json. operations: - method: GET name: deprecated202101getcountriesparamcountryidprovinces description: Shopify Retrieves A List Of Provinces call: shopify-retrieves.deprecated202101getcountriesparamcountryidprovinces with: country_id: rest.country_id since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/countries/{country-id}/provinces/count-json name: admin-api-2021-01-countries-country-id-provinces-count-json description: REST surface for admin-api-2021-01-countries-country_id-provinces-count.json. operations: - method: GET name: deprecated202101getcountriesparamcountryidprovincescount description: Shopify Retrieves A Count Of Provinces For A Country call: shopify-retrieves.deprecated202101getcountriesparamcountryidprovincescount with: country_id: rest.country_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/countries/{country-id}/provinces/province-id-json name: admin-api-2021-01-countries-country-id-provinces-province-id-json description: REST surface for admin-api-2021-01-countries-country_id-provinces-province_id}.json. operations: - method: GET name: deprecated202101getcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-retrieves.deprecated202101getcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/currencies-json name: admin-api-2021-01-currencies-json description: REST surface for admin-api-2021-01-currencies.json. operations: - method: GET name: deprecated202101getcurrencies description: Shopify Retrieves A List Of Currencies Enabled On A Shop call: shopify-retrieves.deprecated202101getcurrencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/custom-collections-json name: admin-api-2021-01-custom-collections-json description: REST surface for admin-api-2021-01-custom_collections.json. operations: - method: GET name: deprecated202101getcustomcollections description: Shopify Retrieves A List Of Custom Collections call: shopify-retrieves.deprecated202101getcustomcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/custom-collections/count-json name: admin-api-2021-01-custom-collections-count-json description: REST surface for admin-api-2021-01-custom_collections-count.json. operations: - method: GET name: deprecated202101getcustomcollectionscount description: Shopify Retrieves A Count Of Custom Collections call: shopify-retrieves.deprecated202101getcustomcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/custom-collections/custom-collection-id-json name: admin-api-2021-01-custom-collections-custom-collection-id-json description: REST surface for admin-api-2021-01-custom_collections-custom_collection_id}.json. operations: - method: GET name: deprecated202101getcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-retrieves.deprecated202101getcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customer-saved-searches-json name: admin-api-2021-01-customer-saved-searches-json description: REST surface for admin-api-2021-01-customer_saved_searches.json. operations: - method: GET name: deprecated202101getcustomersavedsearches description: Shopify Retrieves A List Of Customer Saved Searches call: shopify-retrieves.deprecated202101getcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customer-saved-searches/count-json name: admin-api-2021-01-customer-saved-searches-count-json description: REST surface for admin-api-2021-01-customer_saved_searches-count.json. operations: - method: GET name: deprecated202101getcustomersavedsearchescount description: Shopify Retrieves A Count Of All Customer Saved Searches call: shopify-retrieves.deprecated202101getcustomersavedsearchescount with: since_id: rest.since_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customer-saved-searches/customer-saved-search-id-json name: admin-api-2021-01-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-2021-01-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: deprecated202101getcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-retrieves.deprecated202101getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customer-saved-searches/{customer-saved-search-id}/customers-json name: admin-api-2021-01-customer-saved-searches-customer-saved-search-id-customers-jso description: REST surface for admin-api-2021-01-customer_saved_searches-customer_saved_search_id-customers.jso. operations: - method: GET name: deprecated202101getcustomersavedsearchesparamcustomersavedsearchidcustomers description: Shopify Retrieves All Customers Returned By A Customer Saved Search call: shopify-retrieves.deprecated202101getcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: rest.customer_saved_search_id order: rest.order limit: rest.limit fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customers/{customer-id}/addresses-json name: admin-api-2021-01-customers-customer-id-addresses-json description: REST surface for admin-api-2021-01-customers-customer_id-addresses.json. operations: - method: GET name: deprecated202101getcustomersparamcustomeridaddresses description: Shopify Retrieves A List Of Addresses For A Customer call: shopify-retrieves.deprecated202101getcustomersparamcustomeridaddresses with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customers/{customer-id}/addresses/address-id-json name: admin-api-2021-01-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-2021-01-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: deprecated202101getcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-retrieves.deprecated202101getcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/deprecated-api-calls-json name: admin-api-2021-01-deprecated-api-calls-json description: REST surface for admin-api-2021-01-deprecated_api_calls.json. operations: - method: GET name: deprecated202101getdeprecatedapicalls description: Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days call: shopify-retrieves.deprecated202101getdeprecatedapicalls outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/discount-codes/lookup-json name: admin-api-2021-01-discount-codes-lookup-json description: REST surface for admin-api-2021-01-discount_codes-lookup.json. operations: - method: GET name: deprecated202101getdiscountcodeslookup description: Shopify Retrieves The Location Of A Discount Code call: shopify-retrieves.deprecated202101getdiscountcodeslookup with: code: rest.code outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/events-json name: admin-api-2021-01-events-json description: REST surface for admin-api-2021-01-events.json. operations: - method: GET name: deprecated202101getevents description: Shopify Retrieves A List Of Events call: shopify-retrieves.deprecated202101getevents with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max filter: rest.filter verb: rest.verb fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/events/count-json name: admin-api-2021-01-events-count-json description: REST surface for admin-api-2021-01-events-count.json. operations: - method: GET name: deprecated202101geteventscount description: Shopify Retrieves A Count Of Events call: shopify-retrieves.deprecated202101geteventscount with: created_at_min: rest.created_at_min created_at_max: rest.created_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/events/event-id-json name: admin-api-2021-01-events-event-id-json description: REST surface for admin-api-2021-01-events-event_id}.json. operations: - method: GET name: deprecated202101geteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-retrieves.deprecated202101geteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/fulfillment-orders/fulfillment-order-id-json name: admin-api-2021-01-fulfillment-orders-fulfillment-order-id-json description: REST surface for admin-api-2021-01-fulfillment_orders-fulfillment_order_id}.json. operations: - method: GET name: deprecated202101getfulfillmentordersparamfulfillmentorderid description: Shopify Retrieves A Specific Fulfillment Order call: shopify-retrieves.deprecated202101getfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/fulfillment-orders/{fulfillment-order-id}/fulfillments-json name: admin-api-2021-01-fulfillment-orders-fulfillment-order-id-fulfillments-json description: REST surface for admin-api-2021-01-fulfillment_orders-fulfillment_order_id-fulfillments.json. operations: - method: GET name: deprecated202101getfulfillmentordersparamfulfillmentorderidfulfillments description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order call: shopify-retrieves.deprecated202101getfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/fulfillment-orders/{fulfillment-order-id}/locations-for-move-json name: admin-api-2021-01-fulfillment-orders-fulfillment-order-id-locations-for-move-jso description: REST surface for admin-api-2021-01-fulfillment_orders-fulfillment_order_id-locations_for_move.jso. operations: - method: GET name: deprecated202101getfulfillmentordersparamfulfillmentorderidlocationsformove description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To call: shopify-retrieves.deprecated202101getfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/gift-cards-json name: admin-api-2021-01-gift-cards-json description: REST surface for admin-api-2021-01-gift_cards.json. operations: - method: GET name: deprecated202101getgiftcards description: Shopify Retrieves A List Of Gift Cards call: shopify-retrieves.deprecated202101getgiftcards with: status: rest.status limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/gift-cards/count-json name: admin-api-2021-01-gift-cards-count-json description: REST surface for admin-api-2021-01-gift_cards-count.json. operations: - method: GET name: deprecated202101getgiftcardscount description: Shopify Retrieves A Count Of Gift Cards call: shopify-retrieves.deprecated202101getgiftcardscount with: status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/gift-cards/gift-card-id-json name: admin-api-2021-01-gift-cards-gift-card-id-json description: REST surface for admin-api-2021-01-gift_cards-gift_card_id}.json. operations: - method: GET name: deprecated202101getgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-retrieves.deprecated202101getgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/inventory-items-json name: admin-api-2021-01-inventory-items-json description: REST surface for admin-api-2021-01-inventory_items.json. operations: - method: GET name: deprecated202101getinventoryitems description: Shopify Retrieves A List Of Inventory Items call: shopify-retrieves.deprecated202101getinventoryitems with: ? "ids\n required" : "rest.ids\n required" limit: rest.limit ids: rest.ids outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/inventory-items/inventory-item-id-json name: admin-api-2021-01-inventory-items-inventory-item-id-json description: REST surface for admin-api-2021-01-inventory_items-inventory_item_id}.json. operations: - method: GET name: deprecated202101getinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-retrieves.deprecated202101getinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/inventory-levels-json name: admin-api-2021-01-inventory-levels-json description: REST surface for admin-api-2021-01-inventory_levels.json. operations: - method: GET name: deprecated202101getinventorylevels description: Shopify Retrieves A List Of Inventory Levels call: shopify-retrieves.deprecated202101getinventorylevels with: inventory_item_ids: rest.inventory_item_ids location_ids: rest.location_ids limit: rest.limit updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/locations-json name: admin-api-2021-01-locations-json description: REST surface for admin-api-2021-01-locations.json. operations: - method: GET name: deprecated202101getlocations description: Shopify Retrieves A List Of Locations call: shopify-retrieves.deprecated202101getlocations outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/locations/count-json name: admin-api-2021-01-locations-count-json description: REST surface for admin-api-2021-01-locations-count.json. operations: - method: GET name: deprecated202101getlocationscount description: Shopify Retrieves A Count Of Locations call: shopify-retrieves.deprecated202101getlocationscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/locations/location-id-json name: admin-api-2021-01-locations-location-id-json description: REST surface for admin-api-2021-01-locations-location_id}.json. operations: - method: GET name: deprecated202101getlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-retrieves.deprecated202101getlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/locations/{location-id}/inventory-levels-json name: admin-api-2021-01-locations-location-id-inventory-levels-json description: REST surface for admin-api-2021-01-locations-location_id-inventory_levels.json. operations: - method: GET name: deprecated202101getlocationsparamlocationidinventorylevels description: Shopify Retrieves A List Of Inventory Levels For A Location call: shopify-retrieves.deprecated202101getlocationsparamlocationidinventorylevels with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/metafields-json name: admin-api-2021-01-metafields-json description: REST surface for admin-api-2021-01-metafields.json. operations: - method: GET name: deprecated202101getmetafields description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource call: shopify-retrieves.deprecated202101getmetafields with: metafield[owner_id]: rest.metafield[owner_id] metafield[owner_resource]: rest.metafield[owner_resource] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/metafields/count-json name: admin-api-2021-01-metafields-count-json description: REST surface for admin-api-2021-01-metafields-count.json. operations: - method: GET name: deprecated202101getmetafieldscount description: Shopify Retrieves A Count Of A Resource's Metafields call: shopify-retrieves.deprecated202101getmetafieldscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/metafields/metafield-id-json name: admin-api-2021-01-metafields-metafield-id-json description: REST surface for admin-api-2021-01-metafields-metafield_id}.json. operations: - method: GET name: deprecated202101getmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-retrieves.deprecated202101getmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/fulfillment-orders-json name: admin-api-2021-01-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-2021-01-orders-order_id-fulfillment_orders.json. operations: - method: GET name: deprecated202101getordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-retrieves.deprecated202101getordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/fulfillments-json name: admin-api-2021-01-orders-order-id-fulfillments-json description: REST surface for admin-api-2021-01-orders-order_id-fulfillments.json. operations: - method: GET name: deprecated202101getordersparamorderidfulfillments description: Shopify Retrieves Fulfillments Associated With An Order call: shopify-retrieves.deprecated202101getordersparamorderidfulfillments with: order_id: rest.order_id created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id updated_at_max: rest.updated_at_max updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/fulfillments/count-json name: admin-api-2021-01-orders-order-id-fulfillments-count-json description: REST surface for admin-api-2021-01-orders-order_id-fulfillments-count.json. operations: - method: GET name: deprecated202101getordersparamorderidfulfillmentscount description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order call: shopify-retrieves.deprecated202101getordersparamorderidfulfillmentscount with: order_id: rest.order_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/fulfillments/fulfillment-id-json name: admin-api-2021-01-orders-order-id-fulfillments-fulfillment-id-json description: REST surface for admin-api-2021-01-orders-order_id-fulfillments-fulfillment_id}.json. operations: - method: GET name: deprecated202101getordersparamorderidfulfillmentsparamfulfillmentid description: Shopify Retrieve A Specific Fulfillment call: shopify-retrieves.deprecated202101getordersparamorderidfulfillmentsparamfulfillmentid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/fulfillments/{fulfillment-id}/events-json name: admin-api-2021-01-orders-order-id-fulfillments-fulfillment-id-events-json description: REST surface for admin-api-2021-01-orders-order_id-fulfillments-fulfillment_id-events.json. operations: - method: GET name: deprecated202101getordersparamorderidfulfillmentsparamfulfillmentidevents description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment call: shopify-retrieves.deprecated202101getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/fulfillments/{fulfillment-id}/events/event-id-json name: admin-api-2021-01-orders-order-id-fulfillments-fulfillment-id-events-event-id-j description: REST surface for admin-api-2021-01-orders-order_id-fulfillments-fulfillment_id-events-event_id}.j. operations: - method: GET name: deprecated202101getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid description: Shopify Retrieves A Specific Fulfillment Event call: shopify-retrieves.deprecated202101getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id event_id: rest.event_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/refunds-json name: admin-api-2021-01-orders-order-id-refunds-json description: REST surface for admin-api-2021-01-orders-order_id-refunds.json. operations: - method: GET name: deprecated202101getordersparamorderidrefunds description: Shopify Retrieves A List Of Refunds For An Order call: shopify-retrieves.deprecated202101getordersparamorderidrefunds with: order_id: rest.order_id limit: rest.limit fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/refunds/refund-id-json name: admin-api-2021-01-orders-order-id-refunds-refund-id-json description: REST surface for admin-api-2021-01-orders-order_id-refunds-refund_id}.json. operations: - method: GET name: deprecated202101getordersparamorderidrefundsparamrefundid description: Shopify Retrieves A Specific Refund call: shopify-retrieves.deprecated202101getordersparamorderidrefundsparamrefundid with: order_id: rest.order_id refund_id: rest.refund_id fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/risks-json name: admin-api-2021-01-orders-order-id-risks-json description: REST surface for admin-api-2021-01-orders-order_id-risks.json. operations: - method: GET name: deprecated202101getordersparamorderidrisks description: Shopify Retrieves A List Of All Order Risks For An Order call: shopify-retrieves.deprecated202101getordersparamorderidrisks with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/risks/risk-id-json name: admin-api-2021-01-orders-order-id-risks-risk-id-json description: REST surface for admin-api-2021-01-orders-order_id-risks-risk_id}.json. operations: - method: GET name: deprecated202101getordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-retrieves.deprecated202101getordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/policies-json name: admin-api-2021-01-policies-json description: REST surface for admin-api-2021-01-policies.json. operations: - method: GET name: deprecated202101getpolicies description: Shopify Retrieves A List Of The Shop's Policies call: shopify-retrieves.deprecated202101getpolicies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/price-rules/{price-rule-id}/batch/batch-id-json name: admin-api-2021-01-price-rules-price-rule-id-batch-batch-id-json description: REST surface for admin-api-2021-01-price_rules-price_rule_id-batch-batch_id}.json. operations: - method: GET name: deprecated202101getpricerulesparampriceruleidbatchparambatchid description: Shopify Retrieves A Discount Code Creation Job call: shopify-retrieves.deprecated202101getpricerulesparampriceruleidbatchparambatchid with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/price-rules/{price-rule-id}/batch/{batch-id}/discount-codes-json name: admin-api-2021-01-price-rules-price-rule-id-batch-batch-id-discount-codes-json description: REST surface for admin-api-2021-01-price_rules-price_rule_id-batch-batch_id-discount_codes.json. operations: - method: GET name: deprecated202101getpricerulesparampriceruleidbatchparambatchiddiscountcodes description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job call: shopify-retrieves.deprecated202101getpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/price-rules/{price-rule-id}/discount-codes-json name: admin-api-2021-01-price-rules-price-rule-id-discount-codes-json description: REST surface for admin-api-2021-01-price_rules-price_rule_id-discount_codes.json. operations: - method: GET name: deprecated202101getpricerulesparampriceruleiddiscountcodes description: Shopify Retrieve A List Of Discount Codes call: shopify-retrieves.deprecated202101getpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-2021-01-price-rules-price-rule-id-discount-codes-discount-code-id-jso description: REST surface for admin-api-2021-01-price_rules-price_rule_id-discount_codes-discount_code_id}.jso. operations: - method: GET name: deprecated202101getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-retrieves.deprecated202101getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/products-json name: admin-api-2021-01-products-json description: REST surface for admin-api-2021-01-products.json. operations: - method: GET name: deprecated202101getproducts description: Shopify Retrieves A List Of Products call: shopify-retrieves.deprecated202101getproducts with: ids: rest.ids limit: rest.limit since_id: rest.since_id title: rest.title vendor: rest.vendor handle: rest.handle product_type: rest.product_type status: rest.status collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields presentment_currencies: rest.presentment_currencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/products/count-json name: admin-api-2021-01-products-count-json description: REST surface for admin-api-2021-01-products-count.json. operations: - method: GET name: deprecated202101getproductscount description: Shopify Retrieves A Count Of Products call: shopify-retrieves.deprecated202101getproductscount with: vendor: rest.vendor product_type: rest.product_type collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/products/product-id-json name: admin-api-2021-01-products-product-id-json description: REST surface for admin-api-2021-01-products-product_id}.json. operations: - method: GET name: deprecated202101getproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-retrieves.deprecated202101getproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/redirects-json name: admin-api-2021-01-redirects-json description: REST surface for admin-api-2021-01-redirects.json. operations: - method: GET name: deprecated202101getredirects description: Shopify Retrieves A List Of Url Redirects call: shopify-retrieves.deprecated202101getredirects with: limit: rest.limit since_id: rest.since_id path: rest.path target: rest.target fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/redirects/count-json name: admin-api-2021-01-redirects-count-json description: REST surface for admin-api-2021-01-redirects-count.json. operations: - method: GET name: deprecated202101getredirectscount description: Shopify Retrieves A Count Of Url Redirects call: shopify-retrieves.deprecated202101getredirectscount with: path: rest.path target: rest.target outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/redirects/redirect-id-json name: admin-api-2021-01-redirects-redirect-id-json description: REST surface for admin-api-2021-01-redirects-redirect_id}.json. operations: - method: GET name: deprecated202101getredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-retrieves.deprecated202101getredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/script-tags-json name: admin-api-2021-01-script-tags-json description: REST surface for admin-api-2021-01-script_tags.json. operations: - method: GET name: deprecated202101getscripttags description: Shopify Retrieves A List Of All Script Tags call: shopify-retrieves.deprecated202101getscripttags with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max src: rest.src fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/script-tags/count-json name: admin-api-2021-01-script-tags-count-json description: REST surface for admin-api-2021-01-script_tags-count.json. operations: - method: GET name: deprecated202101getscripttagscount description: Shopify Retrieves A Count Of All Script Tags call: shopify-retrieves.deprecated202101getscripttagscount with: src: rest.src outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/script-tags/script-tag-id-json name: admin-api-2021-01-script-tags-script-tag-id-json description: REST surface for admin-api-2021-01-script_tags-script_tag_id}.json. operations: - method: GET name: deprecated202101getscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-retrieves.deprecated202101getscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/shop-json name: admin-api-2021-01-shop-json description: REST surface for admin-api-2021-01-shop.json. operations: - method: GET name: deprecated202101getshop description: Shopify Retrieves The Shop's Configuration call: shopify-retrieves.deprecated202101getshop with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/shopify-payments/balance-json name: admin-api-2021-01-shopify-payments-balance-json description: REST surface for admin-api-2021-01-shopify_payments-balance.json. operations: - method: GET name: deprecated202101getshopifypaymentsbalance description: Shopify Retrieves The Account's Current Balance call: shopify-retrieves.deprecated202101getshopifypaymentsbalance outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/shopify-payments/payouts-json name: admin-api-2021-01-shopify-payments-payouts-json description: REST surface for admin-api-2021-01-shopify_payments-payouts.json. operations: - method: GET name: deprecated202101getshopifypaymentspayouts description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date call: shopify-retrieves.deprecated202101getshopifypaymentspayouts with: since_id: rest.since_id last_id: rest.last_id date_min: rest.date_min date_max: rest.date_max date: rest.date status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/shopify-payments/payouts/payout-id-json name: admin-api-2021-01-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-2021-01-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: deprecated202101getshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-retrieves.deprecated202101getshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/smart-collections-json name: admin-api-2021-01-smart-collections-json description: REST surface for admin-api-2021-01-smart_collections.json. operations: - method: GET name: deprecated202101getsmartcollections description: Shopify Retrieves A List Of Smart Collections call: shopify-retrieves.deprecated202101getsmartcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/smart-collections/count-json name: admin-api-2021-01-smart-collections-count-json description: REST surface for admin-api-2021-01-smart_collections-count.json. operations: - method: GET name: deprecated202101getsmartcollectionscount description: Shopify Retrieves A Count Of Smart Collections call: shopify-retrieves.deprecated202101getsmartcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/smart-collections/smart-collection-id-json name: admin-api-2021-01-smart-collections-smart-collection-id-json description: REST surface for admin-api-2021-01-smart_collections-smart_collection_id}.json. operations: - method: GET name: deprecated202101getsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-retrieves.deprecated202101getsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/tender-transactions-json name: admin-api-2021-01-tender-transactions-json description: REST surface for admin-api-2021-01-tender_transactions.json. operations: - method: GET name: deprecated202101gettendertransactions description: Shopify Retrieves A List Of Tender Transactions call: shopify-retrieves.deprecated202101gettendertransactions with: limit: rest.limit since_id: rest.since_id processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max processed_at: rest.processed_at order: rest.order outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/themes-json name: admin-api-2021-01-themes-json description: REST surface for admin-api-2021-01-themes.json. operations: - method: GET name: deprecated202101getthemes description: Shopify Retrieves A List Of Themes call: shopify-retrieves.deprecated202101getthemes with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/themes/theme-id-json name: admin-api-2021-01-themes-theme-id-json description: REST surface for admin-api-2021-01-themes-theme_id}.json. operations: - method: GET name: deprecated202101getthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-retrieves.deprecated202101getthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/themes/{theme-id}/assets-json name: admin-api-2021-01-themes-theme-id-assets-json description: REST surface for admin-api-2021-01-themes-theme_id-assets.json. operations: - method: GET name: deprecated202101getthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-retrieves.deprecated202101getthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/users-json name: admin-api-2021-01-users-json description: REST surface for admin-api-2021-01-users.json. operations: - method: GET name: deprecated202101getusers description: Shopify Retrieves A List Of All Users call: shopify-retrieves.deprecated202101getusers with: limit: rest.limit page_info: rest.page_info outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/users/current-json name: admin-api-2021-01-users-current-json description: REST surface for admin-api-2021-01-users-current.json. operations: - method: GET name: deprecated202101getuserscurrent description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request call: shopify-retrieves.deprecated202101getuserscurrent outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/users/user-id-json name: admin-api-2021-01-users-user-id-json description: REST surface for admin-api-2021-01-users-user_id}.json. operations: - method: GET name: deprecated202101getusersparamuserid description: Shopify Retrieves A Single User call: shopify-retrieves.deprecated202101getusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/webhooks-json name: admin-api-2021-01-webhooks-json description: REST surface for admin-api-2021-01-webhooks.json. operations: - method: GET name: deprecated202101getwebhooks description: Shopify Retrieves A List Of Webhooks call: shopify-retrieves.deprecated202101getwebhooks with: address: rest.address created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id topic: rest.topic updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/webhooks/count-json name: admin-api-2021-01-webhooks-count-json description: REST surface for admin-api-2021-01-webhooks-count.json. operations: - method: GET name: deprecated202101getwebhookscount description: Shopify Retrieves A Count Of Existing Webhook Subscriptions call: shopify-retrieves.deprecated202101getwebhookscount with: address: rest.address topic: rest.topic outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/webhooks/webhook-id-json name: admin-api-2021-01-webhooks-webhook-id-json description: REST surface for admin-api-2021-01-webhooks-webhook_id}.json. operations: - method: GET name: deprecated202101getwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-retrieves.deprecated202101getwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/articles/authors-json name: admin-api-unstable-articles-authors-json description: REST surface for admin-api-unstable-articles-authors.json. operations: - method: GET name: deprecatedunstablegetarticlesauthors description: Shopify Retrieves A List All Of Article Authors call: shopify-retrieves.deprecatedunstablegetarticlesauthors outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/articles/tags-json name: admin-api-unstable-articles-tags-json description: REST surface for admin-api-unstable-articles-tags.json. operations: - method: GET name: deprecatedunstablegetarticlestags description: Shopify Retrieves A List Of All The Tags call: shopify-retrieves.deprecatedunstablegetarticlestags with: limit: rest.limit popular: rest.popular outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/assigned-fulfillment-orders-json name: admin-api-unstable-assigned-fulfillment-orders-json description: REST surface for admin-api-unstable-assigned_fulfillment_orders.json. operations: - method: GET name: deprecatedunstablegetassignedfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App call: shopify-retrieves.deprecatedunstablegetassignedfulfillmentorders with: assignment_status: rest.assignment_status location_ids: rest.location_ids location_ids[]: rest.location_ids[] outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/blogs/{blog-id}/articles-json name: admin-api-unstable-blogs-blog-id-articles-json description: REST surface for admin-api-unstable-blogs-blog_id-articles.json. operations: - method: GET name: deprecatedunstablegetblogsparamblogidarticles description: Shopify Retrieves A List Of All Articles From A Blog call: shopify-retrieves.deprecatedunstablegetblogsparamblogidarticles with: blog_id: rest.blog_id limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status handle: rest.handle tag: rest.tag author: rest.author fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/blogs/{blog-id}/articles/count-json name: admin-api-unstable-blogs-blog-id-articles-count-json description: REST surface for admin-api-unstable-blogs-blog_id-articles-count.json. operations: - method: GET name: deprecatedunstablegetblogsparamblogidarticlescount description: Shopify Retrieves A Count Of All Articles From A Blog call: shopify-retrieves.deprecatedunstablegetblogsparamblogidarticlescount with: blog_id: rest.blog_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/blogs/{blog-id}/articles/article-id-json name: admin-api-unstable-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-unstable-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: deprecatedunstablegetblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-retrieves.deprecatedunstablegetblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/carrier-services-json name: admin-api-unstable-carrier-services-json description: REST surface for admin-api-unstable-carrier_services.json. operations: - method: GET name: deprecatedunstablegetcarrierservices description: Shopify Retrieves A List Of Carrier Services call: shopify-retrieves.deprecatedunstablegetcarrierservices outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/carrier-services/carrier-service-id-json name: admin-api-unstable-carrier-services-carrier-service-id-json description: REST surface for admin-api-unstable-carrier_services-carrier_service_id}.json. operations: - method: GET name: deprecatedunstablegetcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-retrieves.deprecatedunstablegetcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/checkouts/count-json name: admin-api-unstable-checkouts-count-json description: REST surface for admin-api-unstable-checkouts-count.json. operations: - method: GET name: deprecatedunstablegetcheckoutscount description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days call: shopify-retrieves.deprecatedunstablegetcheckoutscount with: since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/checkouts/token-json name: admin-api-unstable-checkouts-token-json description: REST surface for admin-api-unstable-checkouts-token}.json. operations: - method: GET name: deprecatedunstablegetcheckoutsparamtoken description: Shopify Retrieves A Checkout call: shopify-retrieves.deprecatedunstablegetcheckoutsparamtoken with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/checkouts/{token}/payments-json name: admin-api-unstable-checkouts-token-payments-json description: REST surface for admin-api-unstable-checkouts-token-payments.json. operations: - method: GET name: deprecatedunstablegetcheckoutsparamtokenpayments description: Shopify Retrieves A List Of Payments On A Particular Checkout call: shopify-retrieves.deprecatedunstablegetcheckoutsparamtokenpayments with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/checkouts/{token}/payments/payment-id-json name: admin-api-unstable-checkouts-token-payments-payment-id-json description: REST surface for admin-api-unstable-checkouts-token-payments-payment_id}.json. operations: - method: GET name: deprecatedunstablegetcheckoutsparamtokenpaymentsparampaymentid description: Shopify Retrieves The Payment Information For An Existing Payment call: shopify-retrieves.deprecatedunstablegetcheckoutsparamtokenpaymentsparampaymentid with: token: rest.token payment_id: rest.payment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/checkouts/{token}/shipping-rates-json name: admin-api-unstable-checkouts-token-shipping-rates-json description: REST surface for admin-api-unstable-checkouts-token-shipping_rates.json. operations: - method: GET name: deprecatedunstablegetcheckoutsparamtokenshippingrates description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout call: shopify-retrieves.deprecatedunstablegetcheckoutsparamtokenshippingrates with: token: rest.token outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/collection-listings-json name: admin-api-unstable-collection-listings-json description: REST surface for admin-api-unstable-collection_listings.json. operations: - method: GET name: deprecatedunstablegetcollectionlistings description: Shopify Retrieve Collection Listings That Are Published To Your App call: shopify-retrieves.deprecatedunstablegetcollectionlistings with: limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/collection-listings/collection-listing-id-json name: admin-api-unstable-collection-listings-collection-listing-id-json description: REST surface for admin-api-unstable-collection_listings-collection_listing_id}.json. operations: - method: GET name: deprecatedunstablegetcollectionlistingsparamcollectionlistingid description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App call: shopify-retrieves.deprecatedunstablegetcollectionlistingsparamcollectionlistingid with: collection_listing_id: rest.collection_listing_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/collection-listings/{collection-listing-id}/product-ids-json name: admin-api-unstable-collection-listings-collection-listing-id-product-ids-json description: REST surface for admin-api-unstable-collection_listings-collection_listing_id-product_ids.json. operations: - method: GET name: deprecatedunstablegetcollectionlistingsparamcollectionlistingidproductids description: Shopify Retrieve Product_ids That Are Published To A Collection_id call: shopify-retrieves.deprecatedunstablegetcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: rest.collection_listing_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/collections/collection-id-json name: admin-api-unstable-collections-collection-id-json description: REST surface for admin-api-unstable-collections-collection_id}.json. operations: - method: GET name: deprecatedunstablegetcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-retrieves.deprecatedunstablegetcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/collections/{collection-id}/products-json name: admin-api-unstable-collections-collection-id-products-json description: REST surface for admin-api-unstable-collections-collection_id-products.json. operations: - method: GET name: deprecatedunstablegetcollectionsparamcollectionidproducts description: Shopify Retrieve A List Of Products Belonging To A Collection call: shopify-retrieves.deprecatedunstablegetcollectionsparamcollectionidproducts with: collection_id: rest.collection_id limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/collects-json name: admin-api-unstable-collects-json description: REST surface for admin-api-unstable-collects.json. operations: - method: GET name: deprecatedunstablegetcollects description: Shopify Retrieves A List Of Collects call: shopify-retrieves.deprecatedunstablegetcollects with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/collects/count-json name: admin-api-unstable-collects-count-json description: REST surface for admin-api-unstable-collects-count.json. operations: - method: GET name: deprecatedunstablegetcollectscount description: Shopify Retrieves A Count Of Collects call: shopify-retrieves.deprecatedunstablegetcollectscount with: collection_id: rest.collection_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/collects/collect-id-json name: admin-api-unstable-collects-collect-id-json description: REST surface for admin-api-unstable-collects-collect_id}.json. operations: - method: GET name: deprecatedunstablegetcollectsparamcollectid description: Shopify Retrieves A Specific Collect By Its Id call: shopify-retrieves.deprecatedunstablegetcollectsparamcollectid with: collect_id: rest.collect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/countries-json name: admin-api-unstable-countries-json description: REST surface for admin-api-unstable-countries.json. operations: - method: GET name: deprecatedunstablegetcountries description: Shopify Retrieves A List Of Countries call: shopify-retrieves.deprecatedunstablegetcountries with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/countries/count-json name: admin-api-unstable-countries-count-json description: REST surface for admin-api-unstable-countries-count.json. operations: - method: GET name: deprecatedunstablegetcountriescount description: Shopify Retrieves A Count Of Countries call: shopify-retrieves.deprecatedunstablegetcountriescount outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/countries/country-id-json name: admin-api-unstable-countries-country-id-json description: REST surface for admin-api-unstable-countries-country_id}.json. operations: - method: GET name: deprecatedunstablegetcountriesparamcountryid description: Shopify Retrieves A Specific County call: shopify-retrieves.deprecatedunstablegetcountriesparamcountryid with: country_id: rest.country_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/countries/{country-id}/provinces-json name: admin-api-unstable-countries-country-id-provinces-json description: REST surface for admin-api-unstable-countries-country_id-provinces.json. operations: - method: GET name: deprecatedunstablegetcountriesparamcountryidprovinces description: Shopify Retrieves A List Of Provinces call: shopify-retrieves.deprecatedunstablegetcountriesparamcountryidprovinces with: country_id: rest.country_id since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/countries/{country-id}/provinces/count-json name: admin-api-unstable-countries-country-id-provinces-count-json description: REST surface for admin-api-unstable-countries-country_id-provinces-count.json. operations: - method: GET name: deprecatedunstablegetcountriesparamcountryidprovincescount description: Shopify Retrieves A Count Of Provinces For A Country call: shopify-retrieves.deprecatedunstablegetcountriesparamcountryidprovincescount with: country_id: rest.country_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/countries/{country-id}/provinces/province-id-json name: admin-api-unstable-countries-country-id-provinces-province-id-json description: REST surface for admin-api-unstable-countries-country_id-provinces-province_id}.json. operations: - method: GET name: deprecatedunstablegetcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-retrieves.deprecatedunstablegetcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/currencies-json name: admin-api-unstable-currencies-json description: REST surface for admin-api-unstable-currencies.json. operations: - method: GET name: deprecatedunstablegetcurrencies description: Shopify Retrieves A List Of Currencies Enabled On A Shop call: shopify-retrieves.deprecatedunstablegetcurrencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/custom-collections-json name: admin-api-unstable-custom-collections-json description: REST surface for admin-api-unstable-custom_collections.json. operations: - method: GET name: deprecatedunstablegetcustomcollections description: Shopify Retrieves A List Of Custom Collections call: shopify-retrieves.deprecatedunstablegetcustomcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/custom-collections/count-json name: admin-api-unstable-custom-collections-count-json description: REST surface for admin-api-unstable-custom_collections-count.json. operations: - method: GET name: deprecatedunstablegetcustomcollectionscount description: Shopify Retrieves A Count Of Custom Collections call: shopify-retrieves.deprecatedunstablegetcustomcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/custom-collections/custom-collection-id-json name: admin-api-unstable-custom-collections-custom-collection-id-json description: REST surface for admin-api-unstable-custom_collections-custom_collection_id}.json. operations: - method: GET name: deprecatedunstablegetcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-retrieves.deprecatedunstablegetcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customer-saved-searches-json name: admin-api-unstable-customer-saved-searches-json description: REST surface for admin-api-unstable-customer_saved_searches.json. operations: - method: GET name: deprecatedunstablegetcustomersavedsearches description: Shopify Retrieves A List Of Customer Saved Searches call: shopify-retrieves.deprecatedunstablegetcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customer-saved-searches/count-json name: admin-api-unstable-customer-saved-searches-count-json description: REST surface for admin-api-unstable-customer_saved_searches-count.json. operations: - method: GET name: deprecatedunstablegetcustomersavedsearchescount description: Shopify Retrieves A Count Of All Customer Saved Searches call: shopify-retrieves.deprecatedunstablegetcustomersavedsearchescount with: since_id: rest.since_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customer-saved-searches/customer-saved-search-id-json name: admin-api-unstable-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-unstable-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-retrieves.deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customer-saved-searches/{customer-saved-search-id}/customers-json name: admin-api-unstable-customer-saved-searches-customer-saved-search-id-customers-js description: REST surface for admin-api-unstable-customer_saved_searches-customer_saved_search_id-customers.js. operations: - method: GET name: deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchidcustomers description: Shopify Retrieves All Customers Returned By A Customer Saved Search call: shopify-retrieves.deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: rest.customer_saved_search_id order: rest.order limit: rest.limit fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customers/count-json name: admin-api-unstable-customers-count-json description: REST surface for admin-api-unstable-customers-count.json. operations: - method: GET name: deprecatedunstablegetcustomerscount description: Shopify Retrieves A Count Of All Customers call: shopify-retrieves.deprecatedunstablegetcustomerscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customers/{customer-id}/addresses-json name: admin-api-unstable-customers-customer-id-addresses-json description: REST surface for admin-api-unstable-customers-customer_id-addresses.json. operations: - method: GET name: deprecatedunstablegetcustomersparamcustomeridaddresses description: Shopify Retrieves A List Of Addresses For A Customer call: shopify-retrieves.deprecatedunstablegetcustomersparamcustomeridaddresses with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customers/{customer-id}/addresses/address-id-json name: admin-api-unstable-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-unstable-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: deprecatedunstablegetcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-retrieves.deprecatedunstablegetcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customers/{customer-id}/orders-json name: admin-api-unstable-customers-customer-id-orders-json description: REST surface for admin-api-unstable-customers-customer_id-orders.json. operations: - method: GET name: deprecatedunstablegetcustomersparamcustomeridorders description: Shopify Retrieves All Orders Belonging To A Customer call: shopify-retrieves.deprecatedunstablegetcustomersparamcustomeridorders with: customer_id: rest.customer_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/deprecated-api-calls-json name: admin-api-unstable-deprecated-api-calls-json description: REST surface for admin-api-unstable-deprecated_api_calls.json. operations: - method: GET name: deprecatedunstablegetdeprecatedapicalls description: Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days call: shopify-retrieves.deprecatedunstablegetdeprecatedapicalls outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/discount-codes/lookup-json name: admin-api-unstable-discount-codes-lookup-json description: REST surface for admin-api-unstable-discount_codes-lookup.json. operations: - method: GET name: deprecatedunstablegetdiscountcodeslookup description: Shopify Retrieves The Location Of A Discount Code call: shopify-retrieves.deprecatedunstablegetdiscountcodeslookup with: code: rest.code outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/events-json name: admin-api-unstable-events-json description: REST surface for admin-api-unstable-events.json. operations: - method: GET name: deprecatedunstablegetevents description: Shopify Retrieves A List Of Events call: shopify-retrieves.deprecatedunstablegetevents with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max filter: rest.filter verb: rest.verb fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/events/count-json name: admin-api-unstable-events-count-json description: REST surface for admin-api-unstable-events-count.json. operations: - method: GET name: deprecatedunstablegeteventscount description: Shopify Retrieves A Count Of Events call: shopify-retrieves.deprecatedunstablegeteventscount with: created_at_min: rest.created_at_min created_at_max: rest.created_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/events/event-id-json name: admin-api-unstable-events-event-id-json description: REST surface for admin-api-unstable-events-event_id}.json. operations: - method: GET name: deprecatedunstablegeteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-retrieves.deprecatedunstablegeteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/fulfillment-orders/fulfillment-order-id-json name: admin-api-unstable-fulfillment-orders-fulfillment-order-id-json description: REST surface for admin-api-unstable-fulfillment_orders-fulfillment_order_id}.json. operations: - method: GET name: deprecatedunstablegetfulfillmentordersparamfulfillmentorderid description: Shopify Retrieves A Specific Fulfillment Order call: shopify-retrieves.deprecatedunstablegetfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/fulfillment-orders/{fulfillment-order-id}/fulfillments-json name: admin-api-unstable-fulfillment-orders-fulfillment-order-id-fulfillments-json description: REST surface for admin-api-unstable-fulfillment_orders-fulfillment_order_id-fulfillments.json. operations: - method: GET name: deprecatedunstablegetfulfillmentordersparamfulfillmentorderidfulfillments description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order call: shopify-retrieves.deprecatedunstablegetfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/fulfillment-orders/{fulfillment-order-id}/locations-for-move-json name: admin-api-unstable-fulfillment-orders-fulfillment-order-id-locations-for-move-js description: REST surface for admin-api-unstable-fulfillment_orders-fulfillment_order_id-locations_for_move.js. operations: - method: GET name: deprecatedunstablegetfulfillmentordersparamfulfillmentorderidlocationsformove description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To call: shopify-retrieves.deprecatedunstablegetfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: rest.fulfillment_order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/gift-cards-json name: admin-api-unstable-gift-cards-json description: REST surface for admin-api-unstable-gift_cards.json. operations: - method: GET name: deprecatedunstablegetgiftcards description: Shopify Retrieves A List Of Gift Cards call: shopify-retrieves.deprecatedunstablegetgiftcards with: status: rest.status limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/gift-cards/count-json name: admin-api-unstable-gift-cards-count-json description: REST surface for admin-api-unstable-gift_cards-count.json. operations: - method: GET name: deprecatedunstablegetgiftcardscount description: Shopify Retrieves A Count Of Gift Cards call: shopify-retrieves.deprecatedunstablegetgiftcardscount with: status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/gift-cards/gift-card-id-json name: admin-api-unstable-gift-cards-gift-card-id-json description: REST surface for admin-api-unstable-gift_cards-gift_card_id}.json. operations: - method: GET name: deprecatedunstablegetgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-retrieves.deprecatedunstablegetgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/inventory-items-json name: admin-api-unstable-inventory-items-json description: REST surface for admin-api-unstable-inventory_items.json. operations: - method: GET name: deprecatedunstablegetinventoryitems description: Shopify Retrieves A List Of Inventory Items call: shopify-retrieves.deprecatedunstablegetinventoryitems with: ? "ids\n required" : "rest.ids\n required" limit: rest.limit ids: rest.ids outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/inventory-items/inventory-item-id-json name: admin-api-unstable-inventory-items-inventory-item-id-json description: REST surface for admin-api-unstable-inventory_items-inventory_item_id}.json. operations: - method: GET name: deprecatedunstablegetinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-retrieves.deprecatedunstablegetinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/inventory-levels-json name: admin-api-unstable-inventory-levels-json description: REST surface for admin-api-unstable-inventory_levels.json. operations: - method: GET name: deprecatedunstablegetinventorylevels description: Shopify Retrieves A List Of Inventory Levels call: shopify-retrieves.deprecatedunstablegetinventorylevels with: inventory_item_ids: rest.inventory_item_ids location_ids: rest.location_ids limit: rest.limit updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/locations-json name: admin-api-unstable-locations-json description: REST surface for admin-api-unstable-locations.json. operations: - method: GET name: deprecatedunstablegetlocations description: Shopify Retrieves A List Of Locations call: shopify-retrieves.deprecatedunstablegetlocations outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/locations/count-json name: admin-api-unstable-locations-count-json description: REST surface for admin-api-unstable-locations-count.json. operations: - method: GET name: deprecatedunstablegetlocationscount description: Shopify Retrieves A Count Of Locations call: shopify-retrieves.deprecatedunstablegetlocationscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/locations/location-id-json name: admin-api-unstable-locations-location-id-json description: REST surface for admin-api-unstable-locations-location_id}.json. operations: - method: GET name: deprecatedunstablegetlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-retrieves.deprecatedunstablegetlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/locations/{location-id}/inventory-levels-json name: admin-api-unstable-locations-location-id-inventory-levels-json description: REST surface for admin-api-unstable-locations-location_id-inventory_levels.json. operations: - method: GET name: deprecatedunstablegetlocationsparamlocationidinventorylevels description: Shopify Retrieves A List Of Inventory Levels For A Location call: shopify-retrieves.deprecatedunstablegetlocationsparamlocationidinventorylevels with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/metafields-json name: admin-api-unstable-metafields-json description: REST surface for admin-api-unstable-metafields.json. operations: - method: GET name: deprecatedunstablegetmetafields description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource call: shopify-retrieves.deprecatedunstablegetmetafields with: metafield[owner_id]: rest.metafield[owner_id] metafield[owner_resource]: rest.metafield[owner_resource] outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/metafields/count-json name: admin-api-unstable-metafields-count-json description: REST surface for admin-api-unstable-metafields-count.json. operations: - method: GET name: deprecatedunstablegetmetafieldscount description: Shopify Retrieves A Count Of A Resource's Metafields call: shopify-retrieves.deprecatedunstablegetmetafieldscount outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/metafields/metafield-id-json name: admin-api-unstable-metafields-metafield-id-json description: REST surface for admin-api-unstable-metafields-metafield_id}.json. operations: - method: GET name: deprecatedunstablegetmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-retrieves.deprecatedunstablegetmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/fulfillment-orders-json name: admin-api-unstable-orders-order-id-fulfillment-orders-json description: REST surface for admin-api-unstable-orders-order_id-fulfillment_orders.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidfulfillmentorders description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillmentorders with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/fulfillments-json name: admin-api-unstable-orders-order-id-fulfillments-json description: REST surface for admin-api-unstable-orders-order_id-fulfillments.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidfulfillments description: Shopify Retrieves Fulfillments Associated With An Order call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillments with: order_id: rest.order_id created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id updated_at_max: rest.updated_at_max updated_at_min: rest.updated_at_min outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/fulfillments/count-json name: admin-api-unstable-orders-order-id-fulfillments-count-json description: REST surface for admin-api-unstable-orders-order_id-fulfillments-count.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidfulfillmentscount description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillmentscount with: order_id: rest.order_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/fulfillments/fulfillment-id-json name: admin-api-unstable-orders-order-id-fulfillments-fulfillment-id-json description: REST surface for admin-api-unstable-orders-order_id-fulfillments-fulfillment_id}.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentid description: Shopify Retrieve A Specific Fulfillment call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/fulfillments/{fulfillment-id}/events-json name: admin-api-unstable-orders-order-id-fulfillments-fulfillment-id-events-json description: REST surface for admin-api-unstable-orders-order_id-fulfillments-fulfillment_id-events.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentidevents description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/fulfillments/{fulfillment-id}/events/event-id-json name: admin-api-unstable-orders-order-id-fulfillments-fulfillment-id-events-event-id description: REST surface for admin-api-unstable-orders-order_id-fulfillments-fulfillment_id-events-event_id}.. operations: - method: GET name: deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentideventsparameventid description: Shopify Retrieves A Specific Fulfillment Event call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: rest.order_id fulfillment_id: rest.fulfillment_id event_id: rest.event_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/refunds-json name: admin-api-unstable-orders-order-id-refunds-json description: REST surface for admin-api-unstable-orders-order_id-refunds.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidrefunds description: Shopify Retrieves A List Of Refunds For An Order call: shopify-retrieves.deprecatedunstablegetordersparamorderidrefunds with: order_id: rest.order_id limit: rest.limit fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/refunds/refund-id-json name: admin-api-unstable-orders-order-id-refunds-refund-id-json description: REST surface for admin-api-unstable-orders-order_id-refunds-refund_id}.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidrefundsparamrefundid description: Shopify Retrieves A Specific Refund call: shopify-retrieves.deprecatedunstablegetordersparamorderidrefundsparamrefundid with: order_id: rest.order_id refund_id: rest.refund_id fields: rest.fields in_shop_currency: rest.in_shop_currency outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/risks-json name: admin-api-unstable-orders-order-id-risks-json description: REST surface for admin-api-unstable-orders-order_id-risks.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidrisks description: Shopify Retrieves A List Of All Order Risks For An Order call: shopify-retrieves.deprecatedunstablegetordersparamorderidrisks with: order_id: rest.order_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/risks/risk-id-json name: admin-api-unstable-orders-order-id-risks-risk-id-json description: REST surface for admin-api-unstable-orders-order_id-risks-risk_id}.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-retrieves.deprecatedunstablegetordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/policies-json name: admin-api-unstable-policies-json description: REST surface for admin-api-unstable-policies.json. operations: - method: GET name: deprecatedunstablegetpolicies description: Shopify Retrieves A List Of The Shop's Policies call: shopify-retrieves.deprecatedunstablegetpolicies outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/price-rules/{price-rule-id}/batch/batch-id-json name: admin-api-unstable-price-rules-price-rule-id-batch-batch-id-json description: REST surface for admin-api-unstable-price_rules-price_rule_id-batch-batch_id}.json. operations: - method: GET name: deprecatedunstablegetpricerulesparampriceruleidbatchparambatchid description: Shopify Retrieves A Discount Code Creation Job call: shopify-retrieves.deprecatedunstablegetpricerulesparampriceruleidbatchparambatchid with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/price-rules/{price-rule-id}/batch/{batch-id}/discount-codes-json name: admin-api-unstable-price-rules-price-rule-id-batch-batch-id-discount-codes-json description: REST surface for admin-api-unstable-price_rules-price_rule_id-batch-batch_id-discount_codes.json. operations: - method: GET name: deprecatedunstablegetpricerulesparampriceruleidbatchparambatchiddiscountcodes description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job call: shopify-retrieves.deprecatedunstablegetpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: rest.price_rule_id batch_id: rest.batch_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/price-rules/{price-rule-id}/discount-codes-json name: admin-api-unstable-price-rules-price-rule-id-discount-codes-json description: REST surface for admin-api-unstable-price_rules-price_rule_id-discount_codes.json. operations: - method: GET name: deprecatedunstablegetpricerulesparampriceruleiddiscountcodes description: Shopify Retrieve A List Of Discount Codes call: shopify-retrieves.deprecatedunstablegetpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-unstable-price-rules-price-rule-id-discount-codes-discount-code-id-js description: REST surface for admin-api-unstable-price_rules-price_rule_id-discount_codes-discount_code_id}.js. operations: - method: GET name: deprecatedunstablegetpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-retrieves.deprecatedunstablegetpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/products-json name: admin-api-unstable-products-json description: REST surface for admin-api-unstable-products.json. operations: - method: GET name: deprecatedunstablegetproducts description: Shopify Retrieves A List Of Products call: shopify-retrieves.deprecatedunstablegetproducts with: ids: rest.ids limit: rest.limit since_id: rest.since_id title: rest.title vendor: rest.vendor handle: rest.handle product_type: rest.product_type status: rest.status collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields presentment_currencies: rest.presentment_currencies outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/products/count-json name: admin-api-unstable-products-count-json description: REST surface for admin-api-unstable-products-count.json. operations: - method: GET name: deprecatedunstablegetproductscount description: Shopify Retrieves A Count Of Products call: shopify-retrieves.deprecatedunstablegetproductscount with: vendor: rest.vendor product_type: rest.product_type collection_id: rest.collection_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/products/product-id-json name: admin-api-unstable-products-product-id-json description: REST surface for admin-api-unstable-products-product_id}.json. operations: - method: GET name: deprecatedunstablegetproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-retrieves.deprecatedunstablegetproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/redirects-json name: admin-api-unstable-redirects-json description: REST surface for admin-api-unstable-redirects.json. operations: - method: GET name: deprecatedunstablegetredirects description: Shopify Retrieves A List Of Url Redirects call: shopify-retrieves.deprecatedunstablegetredirects with: limit: rest.limit since_id: rest.since_id path: rest.path target: rest.target fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/redirects/count-json name: admin-api-unstable-redirects-count-json description: REST surface for admin-api-unstable-redirects-count.json. operations: - method: GET name: deprecatedunstablegetredirectscount description: Shopify Retrieves A Count Of Url Redirects call: shopify-retrieves.deprecatedunstablegetredirectscount with: path: rest.path target: rest.target outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/redirects/redirect-id-json name: admin-api-unstable-redirects-redirect-id-json description: REST surface for admin-api-unstable-redirects-redirect_id}.json. operations: - method: GET name: deprecatedunstablegetredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-retrieves.deprecatedunstablegetredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/script-tags-json name: admin-api-unstable-script-tags-json description: REST surface for admin-api-unstable-script_tags.json. operations: - method: GET name: deprecatedunstablegetscripttags description: Shopify Retrieves A List Of All Script Tags call: shopify-retrieves.deprecatedunstablegetscripttags with: limit: rest.limit since_id: rest.since_id created_at_min: rest.created_at_min created_at_max: rest.created_at_max updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max src: rest.src fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/script-tags/count-json name: admin-api-unstable-script-tags-count-json description: REST surface for admin-api-unstable-script_tags-count.json. operations: - method: GET name: deprecatedunstablegetscripttagscount description: Shopify Retrieves A Count Of All Script Tags call: shopify-retrieves.deprecatedunstablegetscripttagscount with: src: rest.src outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/script-tags/script-tag-id-json name: admin-api-unstable-script-tags-script-tag-id-json description: REST surface for admin-api-unstable-script_tags-script_tag_id}.json. operations: - method: GET name: deprecatedunstablegetscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-retrieves.deprecatedunstablegetscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/shop-json name: admin-api-unstable-shop-json description: REST surface for admin-api-unstable-shop.json. operations: - method: GET name: deprecatedunstablegetshop description: Shopify Retrieves The Shop's Configuration call: shopify-retrieves.deprecatedunstablegetshop with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/shopify-payments/balance-json name: admin-api-unstable-shopify-payments-balance-json description: REST surface for admin-api-unstable-shopify_payments-balance.json. operations: - method: GET name: deprecatedunstablegetshopifypaymentsbalance description: Shopify Retrieves The Account's Current Balance call: shopify-retrieves.deprecatedunstablegetshopifypaymentsbalance outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/shopify-payments/payouts-json name: admin-api-unstable-shopify-payments-payouts-json description: REST surface for admin-api-unstable-shopify_payments-payouts.json. operations: - method: GET name: deprecatedunstablegetshopifypaymentspayouts description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date call: shopify-retrieves.deprecatedunstablegetshopifypaymentspayouts with: since_id: rest.since_id last_id: rest.last_id date_min: rest.date_min date_max: rest.date_max date: rest.date status: rest.status outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/shopify-payments/payouts/payout-id-json name: admin-api-unstable-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-unstable-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: deprecatedunstablegetshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-retrieves.deprecatedunstablegetshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/smart-collections-json name: admin-api-unstable-smart-collections-json description: REST surface for admin-api-unstable-smart_collections.json. operations: - method: GET name: deprecatedunstablegetsmartcollections description: Shopify Retrieves A List Of Smart Collections call: shopify-retrieves.deprecatedunstablegetsmartcollections with: limit: rest.limit ids: rest.ids since_id: rest.since_id title: rest.title product_id: rest.product_id handle: rest.handle updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/smart-collections/count-json name: admin-api-unstable-smart-collections-count-json description: REST surface for admin-api-unstable-smart_collections-count.json. operations: - method: GET name: deprecatedunstablegetsmartcollectionscount description: Shopify Retrieves A Count Of Smart Collections call: shopify-retrieves.deprecatedunstablegetsmartcollectionscount with: title: rest.title product_id: rest.product_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max published_at_min: rest.published_at_min published_at_max: rest.published_at_max published_status: rest.published_status outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/smart-collections/smart-collection-id-json name: admin-api-unstable-smart-collections-smart-collection-id-json description: REST surface for admin-api-unstable-smart_collections-smart_collection_id}.json. operations: - method: GET name: deprecatedunstablegetsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-retrieves.deprecatedunstablegetsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/tender-transactions-json name: admin-api-unstable-tender-transactions-json description: REST surface for admin-api-unstable-tender_transactions.json. operations: - method: GET name: deprecatedunstablegettendertransactions description: Shopify Retrieves A List Of Tender Transactions call: shopify-retrieves.deprecatedunstablegettendertransactions with: limit: rest.limit since_id: rest.since_id processed_at_min: rest.processed_at_min processed_at_max: rest.processed_at_max processed_at: rest.processed_at order: rest.order outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/themes-json name: admin-api-unstable-themes-json description: REST surface for admin-api-unstable-themes.json. operations: - method: GET name: deprecatedunstablegetthemes description: Shopify Retrieves A List Of Themes call: shopify-retrieves.deprecatedunstablegetthemes with: fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/themes/theme-id-json name: admin-api-unstable-themes-theme-id-json description: REST surface for admin-api-unstable-themes-theme_id}.json. operations: - method: GET name: deprecatedunstablegetthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-retrieves.deprecatedunstablegetthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/themes/{theme-id}/assets-json name: admin-api-unstable-themes-theme-id-assets-json description: REST surface for admin-api-unstable-themes-theme_id-assets.json. operations: - method: GET name: deprecatedunstablegetthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-retrieves.deprecatedunstablegetthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/users-json name: admin-api-unstable-users-json description: REST surface for admin-api-unstable-users.json. operations: - method: GET name: deprecatedunstablegetusers description: Shopify Retrieves A List Of All Users call: shopify-retrieves.deprecatedunstablegetusers with: limit: rest.limit page_info: rest.page_info outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/users/current-json name: admin-api-unstable-users-current-json description: REST surface for admin-api-unstable-users-current.json. operations: - method: GET name: deprecatedunstablegetuserscurrent description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request call: shopify-retrieves.deprecatedunstablegetuserscurrent outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/users/user-id-json name: admin-api-unstable-users-user-id-json description: REST surface for admin-api-unstable-users-user_id}.json. operations: - method: GET name: deprecatedunstablegetusersparamuserid description: Shopify Retrieves A Single User call: shopify-retrieves.deprecatedunstablegetusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/webhooks-json name: admin-api-unstable-webhooks-json description: REST surface for admin-api-unstable-webhooks.json. operations: - method: GET name: deprecatedunstablegetwebhooks description: Shopify Retrieves A List Of Webhooks call: shopify-retrieves.deprecatedunstablegetwebhooks with: address: rest.address created_at_max: rest.created_at_max created_at_min: rest.created_at_min fields: rest.fields limit: rest.limit since_id: rest.since_id topic: rest.topic updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/webhooks/count-json name: admin-api-unstable-webhooks-count-json description: REST surface for admin-api-unstable-webhooks-count.json. operations: - method: GET name: deprecatedunstablegetwebhookscount description: Shopify Retrieves A Count Of Existing Webhook Subscriptions call: shopify-retrieves.deprecatedunstablegetwebhookscount with: address: rest.address topic: rest.topic outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/webhooks/webhook-id-json name: admin-api-unstable-webhooks-webhook-id-json description: REST surface for admin-api-unstable-webhooks-webhook_id}.json. operations: - method: GET name: deprecatedunstablegetwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-retrieves.deprecatedunstablegetwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - type: mcp namespace: shopify-retrieves-mcp port: 9090 transport: http description: MCP adapter for Shopify API — Retrieves. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: shopify-retrieves-list-all-article description: Shopify Retrieves A List All Of Article Authors hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getarticlesauthors outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-tags description: Shopify Retrieves A List Of All The Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getarticlestags with: limit: tools.limit popular: tools.popular outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-all-blogs description: Shopify Retrieve A List Of All Blogs hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getblogs with: limit: tools.limit since_id: tools.since_id handle: tools.handle fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-articles description: Shopify Retrieves A List Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getblogsparamblogidarticles with: blog_id: tools.blog_id limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status handle: tools.handle tag: tools.tag author: tools.author fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-articles description: Shopify Retrieves A Count Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getblogsparamblogidarticlescount with: blog_id: tools.blog_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-carrier-services description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcarrierservices outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-checkouts-past description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcheckoutscount with: since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-checkout description: Shopify Retrieves A Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcheckoutsparamtoken with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-payments-particular description: Shopify Retrieves A List Of Payments On A Particular Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcheckoutsparamtokenpayments with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-payment-information-existing description: Shopify Retrieves The Payment Information For An Existing Payment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcheckoutsparamtokenpaymentsparampaymentid with: token: tools.token payment_id: tools.payment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-available-shipping description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcheckoutsparamtokenshippingrates with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieve-collection-listings-that description: Shopify Retrieve Collection Listings That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcollectionlistings with: limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-collection-listing description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcollectionlistingsparamcollectionlistingid with: collection_listing_id: tools.collection_listing_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-ids-that description: Shopify Retrieve Product_ids That Are Published To A Collection_id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: tools.collection_listing_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-products-belonging description: Shopify Retrieve A List Of Products Belonging To A Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcollectionsparamcollectionidproducts with: collection_id: tools.collection_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-collects description: Shopify Retrieves A List Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcollects with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-collects description: Shopify Retrieves A Count Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcollectscount with: collection_id: tools.collection_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-collect-its description: Shopify Retrieves A Specific Collect By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcollectsparamcollectid with: collect_id: tools.collect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-comments description: Shopify Retrieves A List Of Comments hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcomments with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max fields: tools.fields published_status: tools.published_status status: tools.status article_id: tools.article_id blog_id: tools.blog_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-comments description: Shopify Retrieves A Count Of Comments hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcommentscount with: created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status status: tools.status article_id: tools.article_id blog_id: tools.blog_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-comment-its description: Shopify Retrieves A Single Comment By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcommentsparamcommentid with: comment_id: tools.comment_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-countries description: Shopify Retrieves A List Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcountries with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-countries description: Shopify Retrieves A Count Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcountriescount outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-county description: Shopify Retrieves A Specific County hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcountriesparamcountryid with: country_id: tools.country_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-provinces description: Shopify Retrieves A List Of Provinces hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-provinces-country description: Shopify Retrieves A Count Of Provinces For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcountriesparamcountryidprovincescount with: country_id: tools.country_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-currencies-enabled description: Shopify Retrieves A List Of Currencies Enabled On A Shop hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcurrencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-custom-collections description: Shopify Retrieves A List Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcustomcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-custom-collections description: Shopify Retrieves A Count Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcustomcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customer-saved description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-customer description: Shopify Retrieves A Count Of All Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcustomersavedsearchescount with: since_id: tools.since_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-customers-returned description: Shopify Retrieves All Customers Returned By A Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: tools.customer_saved_search_id order: tools.order limit: tools.limit fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-addresses-customer description: Shopify Retrieves A List Of Addresses For A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-location-discount-code description: Shopify Retrieves The Location Of A Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getdiscountcodeslookup with: code: tools.code outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-events description: Shopify Retrieves A List Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getevents with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max filter: tools.filter verb: tools.verb fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-events description: Shopify Retrieves A Count Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001geteventscount with: created_at_min: tools.created_at_min created_at_max: tools.created_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001geteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-order description: Shopify Retrieves A Specific Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-fulfillment description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-that description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-gift-cards description: Shopify Retrieves A List Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-gift-cards description: Shopify Retrieves A Count Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getgiftcardscount with: status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-items description: Shopify Retrieves A List Of Inventory Items hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels description: Shopify Retrieves A List Of Inventory Levels hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getinventorylevels with: inventory_item_ids: tools.inventory_item_ids location_ids: tools.location_ids limit: tools.limit updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations description: Shopify Retrieves A List Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getlocations outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-locations description: Shopify Retrieves A Count Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getlocationscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-2 description: Shopify Retrieves A List Of Inventory Levels For A Location hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getlocationsparamlocationidinventorylevels with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-metafields-that description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-resource-s-metafields description: Shopify Retrieves A Count Of A Resource's Metafields hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getmetafieldscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-orders description: Shopify Retrieves A List Of Orders hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getorders with: ids: tools.ids limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max attribution_app_id: tools.attribution_app_id status: tools.status financial_status: tools.financial_status fulfillment_status: tools.fulfillment_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-order-count description: Shopify Retrieves An Order Count hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getorderscount with: created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max status: tools.status financial_status: tools.financial_status fulfillment_status: tools.fulfillment_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-order description: Shopify Retrieves A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderid with: order_id: tools.order_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-2 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-order description: Shopify Retrieves Fulfillments Associated With An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderidfulfillments with: order_id: tools.order_id created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id updated_at_max: tools.updated_at_max updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-fulfillments-associated description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderidfulfillmentscount with: order_id: tools.order_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-fulfillment description: Shopify Retrieve A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderidfulfillmentsparamfulfillmentid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-events description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-event description: Shopify Retrieves A Specific Fulfillment Event hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id event_id: tools.event_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-refunds-order description: Shopify Retrieves A List Of Refunds For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderidrefunds with: order_id: tools.order_id limit: tools.limit fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-refund description: Shopify Retrieves A Specific Refund hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderidrefundsparamrefundid with: order_id: tools.order_id refund_id: tools.refund_id fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-order description: Shopify Retrieves A List Of All Order Risks For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderidrisks with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-shop-s-policies description: Shopify Retrieves A List Of The Shop's Policies hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getpolicies outputParameters: - type: object mapping: $. - name: shopify-retrieves-discount-code-creation description: Shopify Retrieves A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getpricerulesparampriceruleidbatchparambatchid with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-discount-codes description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-discount-codes description: Shopify Retrieve A List Of Discount Codes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-listings-that description: Shopify Retrieve Product Listings That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getproductlistings with: product_ids: tools.product_ids limit: tools.limit collection_id: tools.collection_id updated_at_min: tools.updated_at_min handle: tools.handle outputParameters: - type: object mapping: $. - name: shopify-retrieve-count-products-that description: Shopify Retrieve A Count Of Products That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getproductlistingscount outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-ids-that-2 description: Shopify Retrieve Product_ids That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getproductlistingsproductids with: limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-product-listing description: Shopify Retrieve A Specific Product Listing That Is Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getproductlistingsparamproductlistingid with: product_listing_id: tools.product_listing_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-products description: Shopify Retrieves A List Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getproducts with: ids: tools.ids limit: tools.limit since_id: tools.since_id title: tools.title vendor: tools.vendor handle: tools.handle product_type: tools.product_type status: tools.status collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields presentment_currencies: tools.presentment_currencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-products description: Shopify Retrieves A Count Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getproductscount with: vendor: tools.vendor product_type: tools.product_type collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-url-redirects description: Shopify Retrieves A List Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getredirects with: limit: tools.limit since_id: tools.since_id path: tools.path target: tools.target fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-url-redirects description: Shopify Retrieves A Count Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getredirectscount with: path: tools.path target: tools.target outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-script description: Shopify Retrieves A List Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getscripttags with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max src: tools.src fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-script description: Shopify Retrieves A Count Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getscripttagscount with: src: tools.src outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-shop-s-configuration description: Shopify Retrieves The Shop's Configuration hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getshop with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-account-s-current-balance description: Shopify Retrieves The Account's Current Balance hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getshopifypaymentsbalance outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-balance description: Shopify Retrieves A List Of All Balance Transactions Ordered By Processingtime hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getshopifypaymentsbalancetransactions with: since_id: tools.since_id last_id: tools.last_id test: tools.test payout_id: tools.payout_id payout_status: tools.payout_status outputParameters: - type: object mapping: $. - name: shopify-retrieve-all-disputes-ordered description: Shopify Retrieve All Disputes Ordered By Initiated_at Date And Time (iso 8601 Format) hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getshopifypaymentsdisputes with: since_id: tools.since_id last_id: tools.last_id status: tools.status initiated_at: tools.initiated_at outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-dispute-id description: Shopify Retrieves A Single Dispute By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getshopifypaymentsdisputesparamdisputeid with: dispute_id: tools.dispute_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-payouts description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getshopifypaymentspayouts with: since_id: tools.since_id last_id: tools.last_id date_min: tools.date_min date_max: tools.date_max date: tools.date status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-smart-collections description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getsmartcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-smart-collections description: Shopify Retrieves A Count Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getsmartcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-tender-transactions description: Shopify Retrieves A List Of Tender Transactions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001gettendertransactions with: limit: tools.limit since_id: tools.since_id processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max processed_at: tools.processed_at order: tools.order outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-themes description: Shopify Retrieves A List Of Themes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getthemes with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-users description: Shopify Retrieves A List Of All Users hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getusers with: limit: tools.limit page_info: tools.page_info outputParameters: - type: object mapping: $. - name: shopify-retrieves-information-about-user description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getuserscurrent outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-webhooks description: Shopify Retrieves A List Of Webhooks hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getwebhooks with: address: tools.address created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id topic: tools.topic updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-existing-webhook description: Shopify Retrieves A Count Of Existing Webhook Subscriptions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getwebhookscount with: address: tools.address topic: tools.topic outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202001getwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-article-2 description: Shopify Retrieves A List All Of Article Authors hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getarticlesauthors outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-tags-2 description: Shopify Retrieves A List Of All The Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getarticlestags with: limit: tools.limit popular: tools.popular outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-3 description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-articles-2 description: Shopify Retrieves A List Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getblogsparamblogidarticles with: blog_id: tools.blog_id limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status handle: tools.handle tag: tools.tag author: tools.author fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-articles-2 description: Shopify Retrieves A Count Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getblogsparamblogidarticlescount with: blog_id: tools.blog_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article-2 description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-carrier-services-2 description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcarrierservices outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service-2 description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-checkouts-past-2 description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcheckoutscount with: since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-checkout-2 description: Shopify Retrieves A Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcheckoutsparamtoken with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-payments-particular-2 description: Shopify Retrieves A List Of Payments On A Particular Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcheckoutsparamtokenpayments with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-payment-information-existing-2 description: Shopify Retrieves The Payment Information For An Existing Payment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcheckoutsparamtokenpaymentsparampaymentid with: token: tools.token payment_id: tools.payment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-available-shipping-2 description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcheckoutsparamtokenshippingrates with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieve-collection-listings-that-2 description: Shopify Retrieve Collection Listings That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcollectionlistings with: limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-collection-listing-2 description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcollectionlistingsparamcollectionlistingid with: collection_listing_id: tools.collection_listing_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-ids-that-3 description: Shopify Retrieve Product_ids That Are Published To A Collection_id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: tools.collection_listing_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection-2 description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-products-belonging-2 description: Shopify Retrieve A List Of Products Belonging To A Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcollectionsparamcollectionidproducts with: collection_id: tools.collection_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-collects-2 description: Shopify Retrieves A List Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcollects with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-collects-2 description: Shopify Retrieves A Count Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcollectscount with: collection_id: tools.collection_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-collect-its-2 description: Shopify Retrieves A Specific Collect By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcollectsparamcollectid with: collect_id: tools.collect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-countries-2 description: Shopify Retrieves A List Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcountries with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-countries-2 description: Shopify Retrieves A Count Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcountriescount outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-county-2 description: Shopify Retrieves A Specific County hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcountriesparamcountryid with: country_id: tools.country_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-provinces-2 description: Shopify Retrieves A List Of Provinces hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-provinces-country-2 description: Shopify Retrieves A Count Of Provinces For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcountriesparamcountryidprovincescount with: country_id: tools.country_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country-2 description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-currencies-enabled-2 description: Shopify Retrieves A List Of Currencies Enabled On A Shop hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcurrencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-custom-collections-2 description: Shopify Retrieves A List Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcustomcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-custom-collections-2 description: Shopify Retrieves A Count Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcustomcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection-2 description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customer-saved-2 description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-customer-2 description: Shopify Retrieves A Count Of All Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcustomersavedsearchescount with: since_id: tools.since_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved-2 description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-customers-returned-2 description: Shopify Retrieves All Customers Returned By A Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: tools.customer_saved_search_id order: tools.order limit: tools.limit fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-addresses-customer-2 description: Shopify Retrieves A List Of Addresses For A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer-2 description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-location-discount-code-2 description: Shopify Retrieves The Location Of A Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getdiscountcodeslookup with: code: tools.code outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-events-2 description: Shopify Retrieves A List Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getevents with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max filter: tools.filter verb: tools.verb fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-events-2 description: Shopify Retrieves A Count Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004geteventscount with: created_at_min: tools.created_at_min created_at_max: tools.created_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its-2 description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004geteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-order-2 description: Shopify Retrieves A Specific Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-fulfillment-2 description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-that-2 description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-gift-cards-2 description: Shopify Retrieves A List Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-gift-cards-2 description: Shopify Retrieves A Count Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getgiftcardscount with: status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card-2 description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-items-2 description: Shopify Retrieves A List Of Inventory Items hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item-2 description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-3 description: Shopify Retrieves A List Of Inventory Levels hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getinventorylevels with: inventory_item_ids: tools.inventory_item_ids location_ids: tools.location_ids limit: tools.limit updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-2 description: Shopify Retrieves A List Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getlocations outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-locations-2 description: Shopify Retrieves A Count Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getlocationscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its-2 description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-4 description: Shopify Retrieves A List Of Inventory Levels For A Location hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getlocationsparamlocationidinventorylevels with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-metafields-that-2 description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-resource-s-metafields-2 description: Shopify Retrieves A Count Of A Resource's Metafields hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getmetafieldscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource-2 description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-orders-2 description: Shopify Retrieves A List Of Orders hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getorders with: ids: tools.ids limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max attribution_app_id: tools.attribution_app_id status: tools.status financial_status: tools.financial_status fulfillment_status: tools.fulfillment_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-order-count-2 description: Shopify Retrieves An Order Count hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getorderscount with: created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max status: tools.status financial_status: tools.financial_status fulfillment_status: tools.fulfillment_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-order-2 description: Shopify Retrieves A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderid with: order_id: tools.order_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-4 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-order-2 description: Shopify Retrieves Fulfillments Associated With An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderidfulfillments with: order_id: tools.order_id created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id updated_at_max: tools.updated_at_max updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-fulfillments-associated-2 description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderidfulfillmentscount with: order_id: tools.order_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-fulfillment-2 description: Shopify Retrieve A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderidfulfillmentsparamfulfillmentid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-events-2 description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-event-2 description: Shopify Retrieves A Specific Fulfillment Event hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id event_id: tools.event_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-refunds-order-2 description: Shopify Retrieves A List Of Refunds For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderidrefunds with: order_id: tools.order_id limit: tools.limit fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-refund-2 description: Shopify Retrieves A Specific Refund hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderidrefundsparamrefundid with: order_id: tools.order_id refund_id: tools.refund_id fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-order-2 description: Shopify Retrieves A List Of All Order Risks For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderidrisks with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk-2 description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-shop-s-policies-2 description: Shopify Retrieves A List Of The Shop's Policies hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getpolicies outputParameters: - type: object mapping: $. - name: shopify-retrieves-discount-code-creation-2 description: Shopify Retrieves A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getpricerulesparampriceruleidbatchparambatchid with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-discount-codes-2 description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-discount-codes-2 description: Shopify Retrieve A List Of Discount Codes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code-2 description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-listings-that-2 description: Shopify Retrieve Product Listings That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getproductlistings with: product_ids: tools.product_ids limit: tools.limit collection_id: tools.collection_id updated_at_min: tools.updated_at_min handle: tools.handle outputParameters: - type: object mapping: $. - name: shopify-retrieve-count-products-that-2 description: Shopify Retrieve A Count Of Products That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getproductlistingscount outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-ids-that-4 description: Shopify Retrieve Product_ids That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getproductlistingsproductids with: limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-product-listing-2 description: Shopify Retrieve A Specific Product Listing That Is Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getproductlistingsparamproductlistingid with: product_listing_id: tools.product_listing_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-products-2 description: Shopify Retrieves A List Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getproducts with: ids: tools.ids limit: tools.limit since_id: tools.since_id title: tools.title vendor: tools.vendor handle: tools.handle product_type: tools.product_type status: tools.status collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields presentment_currencies: tools.presentment_currencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-products-2 description: Shopify Retrieves A Count Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getproductscount with: vendor: tools.vendor product_type: tools.product_type collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product-2 description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-url-redirects-2 description: Shopify Retrieves A List Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getredirects with: limit: tools.limit since_id: tools.since_id path: tools.path target: tools.target fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-url-redirects-2 description: Shopify Retrieves A Count Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getredirectscount with: path: tools.path target: tools.target outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect-2 description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-script-2 description: Shopify Retrieves A List Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getscripttags with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max src: tools.src fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-script-2 description: Shopify Retrieves A Count Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getscripttagscount with: src: tools.src outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag-2 description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-shop-s-configuration-2 description: Shopify Retrieves The Shop's Configuration hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getshop with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-account-s-current-balance-2 description: Shopify Retrieves The Account's Current Balance hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getshopifypaymentsbalance outputParameters: - type: object mapping: $. - name: shopify-retrieve-all-disputes-ordered-2 description: Shopify Retrieve All Disputes Ordered By Initiated_at Date And Time (iso 8601 Format) hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getshopifypaymentsdisputes with: since_id: tools.since_id last_id: tools.last_id status: tools.status initiated_at: tools.initiated_at outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-payouts-2 description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getshopifypaymentspayouts with: since_id: tools.since_id last_id: tools.last_id date_min: tools.date_min date_max: tools.date_max date: tools.date status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id-2 description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-smart-collections-2 description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getsmartcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-smart-collections-2 description: Shopify Retrieves A Count Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getsmartcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection-2 description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-tender-transactions-2 description: Shopify Retrieves A List Of Tender Transactions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004gettendertransactions with: limit: tools.limit since_id: tools.since_id processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max processed_at: tools.processed_at order: tools.order outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-themes-2 description: Shopify Retrieves A List Of Themes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getthemes with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme-2 description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme-2 description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-users-2 description: Shopify Retrieves A List Of All Users hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getusers with: limit: tools.limit page_info: tools.page_info outputParameters: - type: object mapping: $. - name: shopify-retrieves-information-about-user-2 description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getuserscurrent outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user-2 description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-webhooks-2 description: Shopify Retrieves A List Of Webhooks hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getwebhooks with: address: tools.address created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id topic: tools.topic updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-existing-webhook-2 description: Shopify Retrieves A Count Of Existing Webhook Subscriptions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getwebhookscount with: address: tools.address topic: tools.topic outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription-2 description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202004getwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-article-3 description: Shopify Retrieves A List All Of Article Authors hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getarticlesauthors outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-tags-3 description: Shopify Retrieves A List Of All The Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getarticlestags with: limit: tools.limit popular: tools.popular outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-5 description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-articles-3 description: Shopify Retrieves A List Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getblogsparamblogidarticles with: blog_id: tools.blog_id limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status handle: tools.handle tag: tools.tag author: tools.author fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-articles-3 description: Shopify Retrieves A Count Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getblogsparamblogidarticlescount with: blog_id: tools.blog_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article-3 description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-carrier-services-3 description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcarrierservices outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service-3 description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-checkouts-past-3 description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcheckoutscount with: since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-checkout-3 description: Shopify Retrieves A Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcheckoutsparamtoken with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-payments-particular-3 description: Shopify Retrieves A List Of Payments On A Particular Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcheckoutsparamtokenpayments with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-payment-information-existing-3 description: Shopify Retrieves The Payment Information For An Existing Payment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcheckoutsparamtokenpaymentsparampaymentid with: token: tools.token payment_id: tools.payment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-available-shipping-3 description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcheckoutsparamtokenshippingrates with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieve-collection-listings-that-3 description: Shopify Retrieve Collection Listings That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcollectionlistings with: limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-collection-listing-3 description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcollectionlistingsparamcollectionlistingid with: collection_listing_id: tools.collection_listing_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-ids-that-5 description: Shopify Retrieve Product_ids That Are Published To A Collection_id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: tools.collection_listing_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection-3 description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-products-belonging-3 description: Shopify Retrieve A List Of Products Belonging To A Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcollectionsparamcollectionidproducts with: collection_id: tools.collection_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-collects-3 description: Shopify Retrieves A List Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcollects with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-collects-3 description: Shopify Retrieves A Count Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcollectscount with: collection_id: tools.collection_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-collect-its-3 description: Shopify Retrieves A Specific Collect By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcollectsparamcollectid with: collect_id: tools.collect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-countries-3 description: Shopify Retrieves A List Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcountries with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-countries-3 description: Shopify Retrieves A Count Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcountriescount outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-county-3 description: Shopify Retrieves A Specific County hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcountriesparamcountryid with: country_id: tools.country_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-provinces-3 description: Shopify Retrieves A List Of Provinces hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-provinces-country-3 description: Shopify Retrieves A Count Of Provinces For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcountriesparamcountryidprovincescount with: country_id: tools.country_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country-3 description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-currencies-enabled-3 description: Shopify Retrieves A List Of Currencies Enabled On A Shop hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcurrencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-custom-collections-3 description: Shopify Retrieves A List Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcustomcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-custom-collections-3 description: Shopify Retrieves A Count Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcustomcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection-3 description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customer-saved-3 description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-customer-3 description: Shopify Retrieves A Count Of All Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcustomersavedsearchescount with: since_id: tools.since_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved-3 description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-customers-returned-3 description: Shopify Retrieves All Customers Returned By A Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: tools.customer_saved_search_id order: tools.order limit: tools.limit fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-addresses-customer-3 description: Shopify Retrieves A List Of Addresses For A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer-3 description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-location-discount-code-3 description: Shopify Retrieves The Location Of A Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getdiscountcodeslookup with: code: tools.code outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-events-3 description: Shopify Retrieves A List Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getevents with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max filter: tools.filter verb: tools.verb fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-events-3 description: Shopify Retrieves A Count Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007geteventscount with: created_at_min: tools.created_at_min created_at_max: tools.created_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its-3 description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007geteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-order-3 description: Shopify Retrieves A Specific Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-fulfillment-3 description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-that-3 description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-gift-cards-3 description: Shopify Retrieves A List Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-gift-cards-3 description: Shopify Retrieves A Count Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getgiftcardscount with: status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card-3 description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-items-3 description: Shopify Retrieves A List Of Inventory Items hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item-3 description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-5 description: Shopify Retrieves A List Of Inventory Levels hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getinventorylevels with: inventory_item_ids: tools.inventory_item_ids location_ids: tools.location_ids limit: tools.limit updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-3 description: Shopify Retrieves A List Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getlocations outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-locations-3 description: Shopify Retrieves A Count Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getlocationscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its-3 description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-6 description: Shopify Retrieves A List Of Inventory Levels For A Location hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getlocationsparamlocationidinventorylevels with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-metafields-that-3 description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-resource-s-metafields-3 description: Shopify Retrieves A Count Of A Resource's Metafields hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getmetafieldscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource-3 description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-orders-3 description: Shopify Retrieves A List Of Orders hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getorders with: ids: tools.ids limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max attribution_app_id: tools.attribution_app_id status: tools.status financial_status: tools.financial_status fulfillment_status: tools.fulfillment_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-6 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-order-3 description: Shopify Retrieves Fulfillments Associated With An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getordersparamorderidfulfillments with: order_id: tools.order_id created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id updated_at_max: tools.updated_at_max updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-fulfillments-associated-3 description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getordersparamorderidfulfillmentscount with: order_id: tools.order_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-fulfillment-3 description: Shopify Retrieve A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getordersparamorderidfulfillmentsparamfulfillmentid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-events-3 description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-event-3 description: Shopify Retrieves A Specific Fulfillment Event hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id event_id: tools.event_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-refunds-order-3 description: Shopify Retrieves A List Of Refunds For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getordersparamorderidrefunds with: order_id: tools.order_id limit: tools.limit fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-refund-3 description: Shopify Retrieves A Specific Refund hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getordersparamorderidrefundsparamrefundid with: order_id: tools.order_id refund_id: tools.refund_id fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-order-3 description: Shopify Retrieves A List Of All Order Risks For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getordersparamorderidrisks with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk-3 description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-shop-s-policies-3 description: Shopify Retrieves A List Of The Shop's Policies hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getpolicies outputParameters: - type: object mapping: $. - name: shopify-retrieves-discount-code-creation-3 description: Shopify Retrieves A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getpricerulesparampriceruleidbatchparambatchid with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-discount-codes-3 description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-discount-codes-3 description: Shopify Retrieve A List Of Discount Codes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code-3 description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-listings-that-3 description: Shopify Retrieve Product Listings That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getproductlistings with: product_ids: tools.product_ids limit: tools.limit collection_id: tools.collection_id updated_at_min: tools.updated_at_min handle: tools.handle outputParameters: - type: object mapping: $. - name: shopify-retrieve-count-products-that-3 description: Shopify Retrieve A Count Of Products That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getproductlistingscount outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-ids-that-6 description: Shopify Retrieve Product_ids That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getproductlistingsproductids with: limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-product-listing-3 description: Shopify Retrieve A Specific Product Listing That Is Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getproductlistingsparamproductlistingid with: product_listing_id: tools.product_listing_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-products-3 description: Shopify Retrieves A List Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getproducts with: ids: tools.ids limit: tools.limit since_id: tools.since_id title: tools.title vendor: tools.vendor handle: tools.handle product_type: tools.product_type status: tools.status collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields presentment_currencies: tools.presentment_currencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-products-3 description: Shopify Retrieves A Count Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getproductscount with: vendor: tools.vendor product_type: tools.product_type collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product-3 description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-url-redirects-3 description: Shopify Retrieves A List Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getredirects with: limit: tools.limit since_id: tools.since_id path: tools.path target: tools.target fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-url-redirects-3 description: Shopify Retrieves A Count Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getredirectscount with: path: tools.path target: tools.target outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect-3 description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-script-3 description: Shopify Retrieves A List Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getscripttags with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max src: tools.src fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-script-3 description: Shopify Retrieves A Count Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getscripttagscount with: src: tools.src outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag-3 description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-shop-s-configuration-3 description: Shopify Retrieves The Shop's Configuration hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getshop with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-account-s-current-balance-3 description: Shopify Retrieves The Account's Current Balance hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getshopifypaymentsbalance outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-payouts-3 description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getshopifypaymentspayouts with: since_id: tools.since_id last_id: tools.last_id date_min: tools.date_min date_max: tools.date_max date: tools.date status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id-3 description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-smart-collections-3 description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getsmartcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-smart-collections-3 description: Shopify Retrieves A Count Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getsmartcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection-3 description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-tender-transactions-3 description: Shopify Retrieves A List Of Tender Transactions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007gettendertransactions with: limit: tools.limit since_id: tools.since_id processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max processed_at: tools.processed_at order: tools.order outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-themes-3 description: Shopify Retrieves A List Of Themes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getthemes with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme-3 description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme-3 description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-users-3 description: Shopify Retrieves A List Of All Users hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getusers with: limit: tools.limit page_info: tools.page_info outputParameters: - type: object mapping: $. - name: shopify-retrieves-information-about-user-3 description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getuserscurrent outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user-3 description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-webhooks-3 description: Shopify Retrieves A List Of Webhooks hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getwebhooks with: address: tools.address created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id topic: tools.topic updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-existing-webhook-3 description: Shopify Retrieves A Count Of Existing Webhook Subscriptions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getwebhookscount with: address: tools.address topic: tools.topic outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription-3 description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202007getwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-article-4 description: Shopify Retrieves A List All Of Article Authors hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getarticlesauthors outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-tags-4 description: Shopify Retrieves A List Of All The Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getarticlestags with: limit: tools.limit popular: tools.popular outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-7 description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-articles-4 description: Shopify Retrieves A List Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getblogsparamblogidarticles with: blog_id: tools.blog_id limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status handle: tools.handle tag: tools.tag author: tools.author fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-articles-4 description: Shopify Retrieves A Count Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getblogsparamblogidarticlescount with: blog_id: tools.blog_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article-4 description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-carrier-services-4 description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcarrierservices outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service-4 description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-checkouts-past-4 description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcheckoutscount with: since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-checkout-4 description: Shopify Retrieves A Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcheckoutsparamtoken with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-payments-particular-4 description: Shopify Retrieves A List Of Payments On A Particular Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcheckoutsparamtokenpayments with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-payment-information-existing-4 description: Shopify Retrieves The Payment Information For An Existing Payment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcheckoutsparamtokenpaymentsparampaymentid with: token: tools.token payment_id: tools.payment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-available-shipping-4 description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcheckoutsparamtokenshippingrates with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieve-collection-listings-that-4 description: Shopify Retrieve Collection Listings That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcollectionlistings with: limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-collection-listing-4 description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcollectionlistingsparamcollectionlistingid with: collection_listing_id: tools.collection_listing_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-ids-that-7 description: Shopify Retrieve Product_ids That Are Published To A Collection_id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: tools.collection_listing_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection-4 description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-products-belonging-4 description: Shopify Retrieve A List Of Products Belonging To A Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcollectionsparamcollectionidproducts with: collection_id: tools.collection_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-collects-4 description: Shopify Retrieves A List Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcollects with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-collects-4 description: Shopify Retrieves A Count Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcollectscount with: collection_id: tools.collection_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-collect-its-4 description: Shopify Retrieves A Specific Collect By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcollectsparamcollectid with: collect_id: tools.collect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-countries-4 description: Shopify Retrieves A List Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcountries with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-countries-4 description: Shopify Retrieves A Count Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcountriescount outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-county-4 description: Shopify Retrieves A Specific County hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcountriesparamcountryid with: country_id: tools.country_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-provinces-4 description: Shopify Retrieves A List Of Provinces hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-provinces-country-4 description: Shopify Retrieves A Count Of Provinces For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcountriesparamcountryidprovincescount with: country_id: tools.country_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country-4 description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-currencies-enabled-4 description: Shopify Retrieves A List Of Currencies Enabled On A Shop hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcurrencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-custom-collections-4 description: Shopify Retrieves A List Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcustomcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-custom-collections-4 description: Shopify Retrieves A Count Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcustomcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection-4 description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customer-saved-4 description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-customer-4 description: Shopify Retrieves A Count Of All Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcustomersavedsearchescount with: since_id: tools.since_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved-4 description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-customers-returned-4 description: Shopify Retrieves All Customers Returned By A Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: tools.customer_saved_search_id order: tools.order limit: tools.limit fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-addresses-customer-4 description: Shopify Retrieves A List Of Addresses For A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer-4 description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-location-discount-code-4 description: Shopify Retrieves The Location Of A Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getdiscountcodeslookup with: code: tools.code outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-events-4 description: Shopify Retrieves A List Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getevents with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max filter: tools.filter verb: tools.verb fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-events-4 description: Shopify Retrieves A Count Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.geteventscount with: created_at_min: tools.created_at_min created_at_max: tools.created_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its-4 description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.geteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-order-4 description: Shopify Retrieves A Specific Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-fulfillment-4 description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-that-4 description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-gift-cards-4 description: Shopify Retrieves A List Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-gift-cards-4 description: Shopify Retrieves A Count Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getgiftcardscount with: status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card-4 description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-items-4 description: Shopify Retrieves A List Of Inventory Items hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item-4 description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-7 description: Shopify Retrieves A List Of Inventory Levels hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getinventorylevels with: inventory_item_ids: tools.inventory_item_ids location_ids: tools.location_ids limit: tools.limit updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-4 description: Shopify Retrieves A List Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getlocations outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-locations-4 description: Shopify Retrieves A Count Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getlocationscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its-4 description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-8 description: Shopify Retrieves A List Of Inventory Levels For A Location hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getlocationsparamlocationidinventorylevels with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-metafields-that-4 description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-resource-s-metafields-4 description: Shopify Retrieves A Count Of A Resource's Metafields hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getmetafieldscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource-4 description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-8 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-order-4 description: Shopify Retrieves Fulfillments Associated With An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getordersparamorderidfulfillments with: order_id: tools.order_id created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id updated_at_max: tools.updated_at_max updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-fulfillments-associated-4 description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getordersparamorderidfulfillmentscount with: order_id: tools.order_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-fulfillment-4 description: Shopify Retrieve A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getordersparamorderidfulfillmentsparamfulfillmentid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-events-4 description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-event-4 description: Shopify Retrieves A Specific Fulfillment Event hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id event_id: tools.event_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-refunds-order-4 description: Shopify Retrieves A List Of Refunds For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getordersparamorderidrefunds with: order_id: tools.order_id limit: tools.limit fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-refund-4 description: Shopify Retrieves A Specific Refund hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getordersparamorderidrefundsparamrefundid with: order_id: tools.order_id refund_id: tools.refund_id fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-order-4 description: Shopify Retrieves A List Of All Order Risks For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getordersparamorderidrisks with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk-4 description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-shop-s-policies-4 description: Shopify Retrieves A List Of The Shop's Policies hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getpolicies outputParameters: - type: object mapping: $. - name: shopify-retrieves-discount-code-creation-4 description: Shopify Retrieves A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getpricerulesparampriceruleidbatchparambatchid with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-discount-codes-4 description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-discount-codes-4 description: Shopify Retrieve A List Of Discount Codes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code-4 description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-products-4 description: Shopify Retrieves A List Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getproducts with: ids: tools.ids limit: tools.limit since_id: tools.since_id title: tools.title vendor: tools.vendor handle: tools.handle product_type: tools.product_type status: tools.status collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields presentment_currencies: tools.presentment_currencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-products-4 description: Shopify Retrieves A Count Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getproductscount with: vendor: tools.vendor product_type: tools.product_type collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product-4 description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-url-redirects-4 description: Shopify Retrieves A List Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getredirects with: limit: tools.limit since_id: tools.since_id path: tools.path target: tools.target fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-url-redirects-4 description: Shopify Retrieves A Count Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getredirectscount with: path: tools.path target: tools.target outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect-4 description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-script-4 description: Shopify Retrieves A List Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getscripttags with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max src: tools.src fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-script-4 description: Shopify Retrieves A Count Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getscripttagscount with: src: tools.src outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag-4 description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-shop-s-configuration-4 description: Shopify Retrieves The Shop's Configuration hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getshop with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-account-s-current-balance-4 description: Shopify Retrieves The Account's Current Balance hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getshopifypaymentsbalance outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-payouts-4 description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getshopifypaymentspayouts with: since_id: tools.since_id last_id: tools.last_id date_min: tools.date_min date_max: tools.date_max date: tools.date status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id-4 description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-smart-collections-4 description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getsmartcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-smart-collections-4 description: Shopify Retrieves A Count Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getsmartcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection-4 description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-tender-transactions-4 description: Shopify Retrieves A List Of Tender Transactions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.gettendertransactions with: limit: tools.limit since_id: tools.since_id processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max processed_at: tools.processed_at order: tools.order outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-themes-4 description: Shopify Retrieves A List Of Themes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getthemes with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme-4 description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme-4 description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-users-4 description: Shopify Retrieves A List Of All Users hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getusers with: limit: tools.limit page_info: tools.page_info outputParameters: - type: object mapping: $. - name: shopify-retrieves-information-about-user-4 description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getuserscurrent outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user-4 description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-webhooks-4 description: Shopify Retrieves A List Of Webhooks hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getwebhooks with: address: tools.address created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id topic: tools.topic updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-existing-webhook-4 description: Shopify Retrieves A Count Of Existing Webhook Subscriptions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getwebhookscount with: address: tools.address topic: tools.topic outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription-4 description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.getwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-article-5 description: Shopify Retrieves A List All Of Article Authors hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getarticlesauthors outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-tags-5 description: Shopify Retrieves A List Of All The Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getarticlestags with: limit: tools.limit popular: tools.popular outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-9 description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-articles-5 description: Shopify Retrieves A List Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getblogsparamblogidarticles with: blog_id: tools.blog_id limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status handle: tools.handle tag: tools.tag author: tools.author fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-articles-5 description: Shopify Retrieves A Count Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getblogsparamblogidarticlescount with: blog_id: tools.blog_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article-5 description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-carrier-services-5 description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcarrierservices outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service-5 description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-checkouts-past-5 description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcheckoutscount with: since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-checkout-5 description: Shopify Retrieves A Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcheckoutsparamtoken with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-payments-particular-5 description: Shopify Retrieves A List Of Payments On A Particular Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcheckoutsparamtokenpayments with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-payment-information-existing-5 description: Shopify Retrieves The Payment Information For An Existing Payment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcheckoutsparamtokenpaymentsparampaymentid with: token: tools.token payment_id: tools.payment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-available-shipping-5 description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcheckoutsparamtokenshippingrates with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieve-collection-listings-that-5 description: Shopify Retrieve Collection Listings That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcollectionlistings with: limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-collection-listing-5 description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcollectionlistingsparamcollectionlistingid with: collection_listing_id: tools.collection_listing_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-ids-that-8 description: Shopify Retrieve Product_ids That Are Published To A Collection_id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: tools.collection_listing_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection-5 description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-products-belonging-5 description: Shopify Retrieve A List Of Products Belonging To A Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcollectionsparamcollectionidproducts with: collection_id: tools.collection_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-collects-5 description: Shopify Retrieves A List Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcollects with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-collects-5 description: Shopify Retrieves A Count Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcollectscount with: collection_id: tools.collection_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-collect-its-5 description: Shopify Retrieves A Specific Collect By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcollectsparamcollectid with: collect_id: tools.collect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-countries-5 description: Shopify Retrieves A List Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcountries with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-countries-5 description: Shopify Retrieves A Count Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcountriescount outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-county-5 description: Shopify Retrieves A Specific County hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcountriesparamcountryid with: country_id: tools.country_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-provinces-5 description: Shopify Retrieves A List Of Provinces hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-provinces-country-5 description: Shopify Retrieves A Count Of Provinces For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcountriesparamcountryidprovincescount with: country_id: tools.country_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country-5 description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-currencies-enabled-5 description: Shopify Retrieves A List Of Currencies Enabled On A Shop hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcurrencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-custom-collections-5 description: Shopify Retrieves A List Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcustomcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-custom-collections-5 description: Shopify Retrieves A Count Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcustomcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection-5 description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customer-saved-5 description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-customer-5 description: Shopify Retrieves A Count Of All Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcustomersavedsearchescount with: since_id: tools.since_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved-5 description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-customers-returned-5 description: Shopify Retrieves All Customers Returned By A Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: tools.customer_saved_search_id order: tools.order limit: tools.limit fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-addresses-customer-5 description: Shopify Retrieves A List Of Addresses For A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer-5 description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-deprecated-api description: Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getdeprecatedapicalls outputParameters: - type: object mapping: $. - name: shopify-retrieves-location-discount-code-5 description: Shopify Retrieves The Location Of A Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getdiscountcodeslookup with: code: tools.code outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-events-5 description: Shopify Retrieves A List Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getevents with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max filter: tools.filter verb: tools.verb fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-events-5 description: Shopify Retrieves A Count Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101geteventscount with: created_at_min: tools.created_at_min created_at_max: tools.created_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its-5 description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101geteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-order-5 description: Shopify Retrieves A Specific Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-fulfillment-5 description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-that-5 description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-gift-cards-5 description: Shopify Retrieves A List Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-gift-cards-5 description: Shopify Retrieves A Count Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getgiftcardscount with: status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card-5 description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-items-5 description: Shopify Retrieves A List Of Inventory Items hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item-5 description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-9 description: Shopify Retrieves A List Of Inventory Levels hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getinventorylevels with: inventory_item_ids: tools.inventory_item_ids location_ids: tools.location_ids limit: tools.limit updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-5 description: Shopify Retrieves A List Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getlocations outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-locations-5 description: Shopify Retrieves A Count Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getlocationscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its-5 description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-10 description: Shopify Retrieves A List Of Inventory Levels For A Location hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getlocationsparamlocationidinventorylevels with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-metafields-that-5 description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-resource-s-metafields-5 description: Shopify Retrieves A Count Of A Resource's Metafields hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getmetafieldscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource-5 description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-10 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-order-5 description: Shopify Retrieves Fulfillments Associated With An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getordersparamorderidfulfillments with: order_id: tools.order_id created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id updated_at_max: tools.updated_at_max updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-fulfillments-associated-5 description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getordersparamorderidfulfillmentscount with: order_id: tools.order_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-fulfillment-5 description: Shopify Retrieve A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getordersparamorderidfulfillmentsparamfulfillmentid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-events-5 description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-event-5 description: Shopify Retrieves A Specific Fulfillment Event hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id event_id: tools.event_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-refunds-order-5 description: Shopify Retrieves A List Of Refunds For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getordersparamorderidrefunds with: order_id: tools.order_id limit: tools.limit fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-refund-5 description: Shopify Retrieves A Specific Refund hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getordersparamorderidrefundsparamrefundid with: order_id: tools.order_id refund_id: tools.refund_id fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-order-5 description: Shopify Retrieves A List Of All Order Risks For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getordersparamorderidrisks with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk-5 description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-shop-s-policies-5 description: Shopify Retrieves A List Of The Shop's Policies hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getpolicies outputParameters: - type: object mapping: $. - name: shopify-retrieves-discount-code-creation-5 description: Shopify Retrieves A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getpricerulesparampriceruleidbatchparambatchid with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-discount-codes-5 description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-discount-codes-5 description: Shopify Retrieve A List Of Discount Codes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code-5 description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-products-5 description: Shopify Retrieves A List Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getproducts with: ids: tools.ids limit: tools.limit since_id: tools.since_id title: tools.title vendor: tools.vendor handle: tools.handle product_type: tools.product_type status: tools.status collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields presentment_currencies: tools.presentment_currencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-products-5 description: Shopify Retrieves A Count Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getproductscount with: vendor: tools.vendor product_type: tools.product_type collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product-5 description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-url-redirects-5 description: Shopify Retrieves A List Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getredirects with: limit: tools.limit since_id: tools.since_id path: tools.path target: tools.target fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-url-redirects-5 description: Shopify Retrieves A Count Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getredirectscount with: path: tools.path target: tools.target outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect-5 description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-script-5 description: Shopify Retrieves A List Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getscripttags with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max src: tools.src fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-script-5 description: Shopify Retrieves A Count Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getscripttagscount with: src: tools.src outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag-5 description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-shop-s-configuration-5 description: Shopify Retrieves The Shop's Configuration hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getshop with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-account-s-current-balance-5 description: Shopify Retrieves The Account's Current Balance hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getshopifypaymentsbalance outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-payouts-5 description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getshopifypaymentspayouts with: since_id: tools.since_id last_id: tools.last_id date_min: tools.date_min date_max: tools.date_max date: tools.date status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id-5 description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-smart-collections-5 description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getsmartcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-smart-collections-5 description: Shopify Retrieves A Count Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getsmartcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection-5 description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-tender-transactions-5 description: Shopify Retrieves A List Of Tender Transactions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101gettendertransactions with: limit: tools.limit since_id: tools.since_id processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max processed_at: tools.processed_at order: tools.order outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-themes-5 description: Shopify Retrieves A List Of Themes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getthemes with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme-5 description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme-5 description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-users-5 description: Shopify Retrieves A List Of All Users hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getusers with: limit: tools.limit page_info: tools.page_info outputParameters: - type: object mapping: $. - name: shopify-retrieves-information-about-user-5 description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getuserscurrent outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user-5 description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-webhooks-5 description: Shopify Retrieves A List Of Webhooks hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getwebhooks with: address: tools.address created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id topic: tools.topic updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-existing-webhook-5 description: Shopify Retrieves A Count Of Existing Webhook Subscriptions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getwebhookscount with: address: tools.address topic: tools.topic outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription-5 description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecated202101getwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-article-6 description: Shopify Retrieves A List All Of Article Authors hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetarticlesauthors outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-tags-6 description: Shopify Retrieves A List Of All The Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetarticlestags with: limit: tools.limit popular: tools.popular outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-11 description: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetassignedfulfillmentorders with: assignment_status: tools.assignment_status location_ids: tools.location_ids location_ids[]: tools.location_ids[] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-articles-6 description: Shopify Retrieves A List Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetblogsparamblogidarticles with: blog_id: tools.blog_id limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status handle: tools.handle tag: tools.tag author: tools.author fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-articles-6 description: Shopify Retrieves A Count Of All Articles From A Blog hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetblogsparamblogidarticlescount with: blog_id: tools.blog_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article-6 description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-carrier-services-6 description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcarrierservices outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service-6 description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-checkouts-past-6 description: Shopify Retrieves A Count Of Checkouts From The Past 90 Days hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcheckoutscount with: since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-checkout-6 description: Shopify Retrieves A Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcheckoutsparamtoken with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-payments-particular-6 description: Shopify Retrieves A List Of Payments On A Particular Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcheckoutsparamtokenpayments with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieves-payment-information-existing-6 description: Shopify Retrieves The Payment Information For An Existing Payment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcheckoutsparamtokenpaymentsparampaymentid with: token: tools.token payment_id: tools.payment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-available-shipping-6 description: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcheckoutsparamtokenshippingrates with: token: tools.token outputParameters: - type: object mapping: $. - name: shopify-retrieve-collection-listings-that-6 description: Shopify Retrieve Collection Listings That Are Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcollectionlistings with: limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-collection-listing-6 description: Shopify Retrieve A Specific Collection Listing That Is Published To Your App hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcollectionlistingsparamcollectionlistingid with: collection_listing_id: tools.collection_listing_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-product-ids-that-9 description: Shopify Retrieve Product_ids That Are Published To A Collection_id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcollectionlistingsparamcollectionlistingidproductids with: collection_listing_id: tools.collection_listing_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection-6 description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-products-belonging-6 description: Shopify Retrieve A List Of Products Belonging To A Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcollectionsparamcollectionidproducts with: collection_id: tools.collection_id limit: tools.limit outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-collects-6 description: Shopify Retrieves A List Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcollects with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-collects-6 description: Shopify Retrieves A Count Of Collects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcollectscount with: collection_id: tools.collection_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-collect-its-6 description: Shopify Retrieves A Specific Collect By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcollectsparamcollectid with: collect_id: tools.collect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-countries-6 description: Shopify Retrieves A List Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcountries with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-countries-6 description: Shopify Retrieves A Count Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcountriescount outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-county-6 description: Shopify Retrieves A Specific County hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcountriesparamcountryid with: country_id: tools.country_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-provinces-6 description: Shopify Retrieves A List Of Provinces hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-provinces-country-6 description: Shopify Retrieves A Count Of Provinces For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcountriesparamcountryidprovincescount with: country_id: tools.country_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country-6 description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-currencies-enabled-6 description: Shopify Retrieves A List Of Currencies Enabled On A Shop hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcurrencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-custom-collections-6 description: Shopify Retrieves A List Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-custom-collections-6 description: Shopify Retrieves A Count Of Custom Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection-6 description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customer-saved-6 description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-customer-6 description: Shopify Retrieves A Count Of All Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomersavedsearchescount with: since_id: tools.since_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved-6 description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-customers-returned-6 description: Shopify Retrieves All Customers Returned By A Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchidcustomers with: customer_saved_search_id: tools.customer_saved_search_id order: tools.order limit: tools.limit fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-customers description: Shopify Retrieves A Count Of All Customers hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomerscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-addresses-customer-6 description: Shopify Retrieves A List Of Addresses For A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer-6 description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-all-orders-belonging description: Shopify Retrieves All Orders Belonging To A Customer hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetcustomersparamcustomeridorders with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-deprecated-api-2 description: Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetdeprecatedapicalls outputParameters: - type: object mapping: $. - name: shopify-retrieves-location-discount-code-6 description: Shopify Retrieves The Location Of A Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetdiscountcodeslookup with: code: tools.code outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-events-6 description: Shopify Retrieves A List Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetevents with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max filter: tools.filter verb: tools.verb fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-events-6 description: Shopify Retrieves A Count Of Events hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegeteventscount with: created_at_min: tools.created_at_min created_at_max: tools.created_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its-6 description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegeteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-order-6 description: Shopify Retrieves A Specific Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetfulfillmentordersparamfulfillmentorderid with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-fulfillment-6 description: Shopify Retrieves Fulfillments Associated With A Fulfillment Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetfulfillmentordersparamfulfillmentorderidfulfillments with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-that-6 description: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetfulfillmentordersparamfulfillmentorderidlocationsformove with: fulfillment_order_id: tools.fulfillment_order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-gift-cards-6 description: Shopify Retrieves A List Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-gift-cards-6 description: Shopify Retrieves A Count Of Gift Cards hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetgiftcardscount with: status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card-6 description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-items-6 description: Shopify Retrieves A List Of Inventory Items hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item-6 description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-11 description: Shopify Retrieves A List Of Inventory Levels hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetinventorylevels with: inventory_item_ids: tools.inventory_item_ids location_ids: tools.location_ids limit: tools.limit updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-locations-6 description: Shopify Retrieves A List Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetlocations outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-locations-6 description: Shopify Retrieves A Count Of Locations hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetlocationscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its-6 description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-inventory-levels-12 description: Shopify Retrieves A List Of Inventory Levels For A Location hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetlocationsparamlocationidinventorylevels with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-metafields-that-6 description: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-resource-s-metafields-6 description: Shopify Retrieves A Count Of A Resource's Metafields hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetmetafieldscount outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource-6 description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-orders-12 description: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillmentorders with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-fulfillments-associated-order-6 description: Shopify Retrieves Fulfillments Associated With An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillments with: order_id: tools.order_id created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id updated_at_max: tools.updated_at_max updated_at_min: tools.updated_at_min outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-fulfillments-associated-6 description: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillmentscount with: order_id: tools.order_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieve-specific-fulfillment-6 description: Shopify Retrieve A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-fulfillment-events-6 description: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-fulfillment-event-6 description: Shopify Retrieves A Specific Fulfillment Event hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentideventsparameventid with: order_id: tools.order_id fulfillment_id: tools.fulfillment_id event_id: tools.event_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-refunds-order-6 description: Shopify Retrieves A List Of Refunds For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetordersparamorderidrefunds with: order_id: tools.order_id limit: tools.limit fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-specific-refund-6 description: Shopify Retrieves A Specific Refund hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetordersparamorderidrefundsparamrefundid with: order_id: tools.order_id refund_id: tools.refund_id fields: tools.fields in_shop_currency: tools.in_shop_currency outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-order-6 description: Shopify Retrieves A List Of All Order Risks For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetordersparamorderidrisks with: order_id: tools.order_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk-6 description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-shop-s-policies-6 description: Shopify Retrieves A List Of The Shop's Policies hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetpolicies outputParameters: - type: object mapping: $. - name: shopify-retrieves-discount-code-creation-6 description: Shopify Retrieves A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetpricerulesparampriceruleidbatchparambatchid with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-discount-codes-6 description: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetpricerulesparampriceruleidbatchparambatchiddiscountcodes with: price_rule_id: tools.price_rule_id batch_id: tools.batch_id outputParameters: - type: object mapping: $. - name: shopify-retrieve-list-discount-codes-6 description: Shopify Retrieve A List Of Discount Codes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code-6 description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-products-6 description: Shopify Retrieves A List Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetproducts with: ids: tools.ids limit: tools.limit since_id: tools.since_id title: tools.title vendor: tools.vendor handle: tools.handle product_type: tools.product_type status: tools.status collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields presentment_currencies: tools.presentment_currencies outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-products-6 description: Shopify Retrieves A Count Of Products hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetproductscount with: vendor: tools.vendor product_type: tools.product_type collection_id: tools.collection_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product-6 description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-url-redirects-6 description: Shopify Retrieves A List Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetredirects with: limit: tools.limit since_id: tools.since_id path: tools.path target: tools.target fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-url-redirects-6 description: Shopify Retrieves A Count Of Url Redirects hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetredirectscount with: path: tools.path target: tools.target outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect-6 description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-script-6 description: Shopify Retrieves A List Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetscripttags with: limit: tools.limit since_id: tools.since_id created_at_min: tools.created_at_min created_at_max: tools.created_at_max updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max src: tools.src fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-all-script-6 description: Shopify Retrieves A Count Of All Script Tags hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetscripttagscount with: src: tools.src outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag-6 description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-shop-s-configuration-6 description: Shopify Retrieves The Shop's Configuration hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetshop with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-account-s-current-balance-6 description: Shopify Retrieves The Account's Current Balance hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetshopifypaymentsbalance outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-payouts-6 description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetshopifypaymentspayouts with: since_id: tools.since_id last_id: tools.last_id date_min: tools.date_min date_max: tools.date_max date: tools.date status: tools.status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id-6 description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-smart-collections-6 description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetsmartcollections with: limit: tools.limit ids: tools.ids since_id: tools.since_id title: tools.title product_id: tools.product_id handle: tools.handle updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-smart-collections-6 description: Shopify Retrieves A Count Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetsmartcollectionscount with: title: tools.title product_id: tools.product_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max published_at_min: tools.published_at_min published_at_max: tools.published_at_max published_status: tools.published_status outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection-6 description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-tender-transactions-6 description: Shopify Retrieves A List Of Tender Transactions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegettendertransactions with: limit: tools.limit since_id: tools.since_id processed_at_min: tools.processed_at_min processed_at_max: tools.processed_at_max processed_at: tools.processed_at order: tools.order outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-themes-6 description: Shopify Retrieves A List Of Themes hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetthemes with: fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme-6 description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme-6 description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-users-6 description: Shopify Retrieves A List Of All Users hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetusers with: limit: tools.limit page_info: tools.page_info outputParameters: - type: object mapping: $. - name: shopify-retrieves-information-about-user-6 description: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetuserscurrent outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user-6 description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-webhooks-6 description: Shopify Retrieves A List Of Webhooks hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetwebhooks with: address: tools.address created_at_max: tools.created_at_max created_at_min: tools.created_at_min fields: tools.fields limit: tools.limit since_id: tools.since_id topic: tools.topic updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max outputParameters: - type: object mapping: $. - name: shopify-retrieves-count-existing-webhook-6 description: Shopify Retrieves A Count Of Existing Webhook Subscriptions hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetwebhookscount with: address: tools.address topic: tools.topic outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription-6 description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-retrieves.deprecatedunstablegetwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $.