naftiko: 1.0.0-alpha2 info: label: Shopify API — Lists description: 'Shopify API — Lists. 291 operations. Lead operation: Shopify Retrieves A List Of Application Charges. Self-contained Naftiko capability covering one Shopify business surface.' tags: - Shopify - Lists created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: SHOPIFY_API_KEY: SHOPIFY_API_KEY capability: consumes: - type: http namespace: shopify-lists baseUri: '' description: Shopify API — Lists business capability. Self-contained, no shared references. resources: - name: admin-api-2020-01-application_charges.json path: /admin/api/2020-01/application_charges.json operations: - name: deprecated202001getapplicationcharges method: GET description: Shopify Retrieves A List Of Application Charges 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: A comma-separated list of fields to include in the response. - 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-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-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-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-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-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-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-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-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-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-customers.json path: /admin/api/2020-01/customers.json operations: - name: deprecated202001getcustomers method: GET description: Shopify Retrieves A List Of Customers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Restrict results to customers specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to those after the specified ID. - name: created_at_min in: query type: string description: 'Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)' - 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: deprecated202001deletecustomersparamcustomeridaddressesparamaddressid method: DELETE description: Shopify Removes An Address From A Customer’s Address List 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-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-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-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_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-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-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-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-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-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-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-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-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-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-recurring_application_charges.json path: /admin/api/2020-01/recurring_application_charges.json operations: - name: deprecated202001getrecurringapplicationcharges method: GET description: Shopify Retrieves A List Of Recurring Application Charges 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: A comma-separated list of fields to include in the response. - name: admin-api-2020-01-recurring_application_charges-recurring_application_charge_id- path: /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json operations: - name: deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges method: GET description: Shopify Retrieves A List Of Usage Charges outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: recurring_application_charge_id in: path type: string description: recurring_application_charge_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-reports.json path: /admin/api/2020-01/reports.json operations: - name: deprecated202001getreports method: GET description: Shopify Retrieves A List Of Reports outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: A comma-separated list of report IDs. - name: limit in: query type: string description: The amount of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_min in: query type: string description: 'Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show reports last updated before 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: 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-shipping_zones.json path: /admin/api/2020-01/shipping_zones.json operations: - name: deprecated202001getshippingzones method: GET description: Shopify Get A List Of All Shipping Zones outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: comma-separated list of fields to include in the response - 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-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-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-storefront_access_tokens.json path: /admin/api/2020-01/storefront_access_tokens.json operations: - name: deprecated202001getstorefrontaccesstokens method: GET description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued outputRawFormat: json outputParameters: - name: result type: object value: $. - 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-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-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-04-application_charges.json path: /admin/api/2020-04/application_charges.json operations: - name: deprecated202004getapplicationcharges method: GET description: Shopify Retrieves A List Of Application Charges 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: A comma-separated list of fields to include in the response. - 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-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-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-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-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-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-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-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-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-customers.json path: /admin/api/2020-04/customers.json operations: - name: deprecated202004getcustomers method: GET description: Shopify Retrieves A List Of Customers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Restrict results to customers specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to those after the specified ID. - name: created_at_min in: query type: string description: 'Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)' - 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: deprecated202004deletecustomersparamcustomeridaddressesparamaddressid method: DELETE description: Shopify Removes An Address From A Customer’s Address List 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-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-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-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_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-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-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-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-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-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-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-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-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-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-recurring_application_charges.json path: /admin/api/2020-04/recurring_application_charges.json operations: - name: deprecated202004getrecurringapplicationcharges method: GET description: Shopify Retrieves A List Of Recurring Application Charges 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: A comma-separated list of fields to include in the response. - name: admin-api-2020-04-recurring_application_charges-recurring_application_charge_id- path: /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json operations: - name: deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges method: GET description: Shopify Retrieves A List Of Usage Charges outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: recurring_application_charge_id in: path type: string description: recurring_application_charge_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-reports.json path: /admin/api/2020-04/reports.json operations: - name: deprecated202004getreports method: GET description: Shopify Retrieves A List Of Reports outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: A comma-separated list of report IDs. - name: limit in: query type: string description: The amount of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_min in: query type: string description: 'Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show reports last updated before 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: 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-shipping_zones.json path: /admin/api/2020-04/shipping_zones.json operations: - name: deprecated202004getshippingzones method: GET description: Shopify Get A List Of All Shipping Zones outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: comma-separated list of fields to include in the response - 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-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-storefront_access_tokens.json path: /admin/api/2020-04/storefront_access_tokens.json operations: - name: deprecated202004getstorefrontaccesstokens method: GET description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued outputRawFormat: json outputParameters: - name: result type: object value: $. - 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-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-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-07-application_charges.json path: /admin/api/2020-07/application_charges.json operations: - name: deprecated202007getapplicationcharges method: GET description: Shopify Retrieves A List Of Application Charges 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: A comma-separated list of fields to include in the response. - 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-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-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-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-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-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-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-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-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-customers.json path: /admin/api/2020-07/customers.json operations: - name: deprecated202007getcustomers method: GET description: Shopify Retrieves A List Of Customers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Restrict results to customers specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to those after the specified ID. - name: created_at_min in: query type: string description: 'Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)' - 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: deprecated202007deletecustomersparamcustomeridaddressesparamaddressid method: DELETE description: Shopify Removes An Address From A Customer’s Address List 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-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-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-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_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-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-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-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-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-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-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-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-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-recurring_application_charges.json path: /admin/api/2020-07/recurring_application_charges.json operations: - name: deprecated202007getrecurringapplicationcharges method: GET description: Shopify Retrieves A List Of Recurring Application Charges 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: A comma-separated list of fields to include in the response. - name: admin-api-2020-07-recurring_application_charges-recurring_application_charge_id- path: /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json operations: - name: deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges method: GET description: Shopify Retrieves A List Of Usage Charges outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: recurring_application_charge_id in: path type: string description: recurring_application_charge_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-reports.json path: /admin/api/2020-07/reports.json operations: - name: deprecated202007getreports method: GET description: Shopify Retrieves A List Of Reports outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: A comma-separated list of report IDs. - name: limit in: query type: string description: The amount of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_min in: query type: string description: 'Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show reports last updated before 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: 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-shipping_zones.json path: /admin/api/2020-07/shipping_zones.json operations: - name: deprecated202007getshippingzones method: GET description: Shopify Get A List Of All Shipping Zones outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: comma-separated list of fields to include in the response - 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-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-storefront_access_tokens.json path: /admin/api/2020-07/storefront_access_tokens.json operations: - name: deprecated202007getstorefrontaccesstokens method: GET description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued outputRawFormat: json outputParameters: - name: result type: object value: $. - 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-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-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-10-application_charges.json path: /admin/api/2020-10/application_charges.json operations: - name: getapplicationcharges method: GET description: Shopify Retrieves A List Of Application Charges 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: A comma-separated list of fields to include in the response. - 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-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-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-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-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-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-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-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-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-customers.json path: /admin/api/2020-10/customers.json operations: - name: getcustomers method: GET description: Shopify Retrieves A List Of Customers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Restrict results to customers specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to those after the specified ID. - name: created_at_min in: query type: string description: 'Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)' - 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: deletecustomersparamcustomeridaddressesparamaddressid method: DELETE description: Shopify Removes An Address From A Customer’s Address List 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-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-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-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_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-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-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-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-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-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-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-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-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-recurring_application_charges.json path: /admin/api/2020-10/recurring_application_charges.json operations: - name: getrecurringapplicationcharges method: GET description: Shopify Retrieves A List Of Recurring Application Charges 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: A comma-separated list of fields to include in the response. - name: admin-api-2020-10-recurring_application_charges-recurring_application_charge_id- path: /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json operations: - name: getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges method: GET description: Shopify Retrieves A List Of Usage Charges outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: recurring_application_charge_id in: path type: string description: recurring_application_charge_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-reports.json path: /admin/api/2020-10/reports.json operations: - name: getreports method: GET description: Shopify Retrieves A List Of Reports outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: A comma-separated list of report IDs. - name: limit in: query type: string description: The amount of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_min in: query type: string description: 'Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show reports last updated before 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: 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-shipping_zones.json path: /admin/api/2020-10/shipping_zones.json operations: - name: getshippingzones method: GET description: Shopify Get A List Of All Shipping Zones outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: comma-separated list of fields to include in the response - 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-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-storefront_access_tokens.json path: /admin/api/2020-10/storefront_access_tokens.json operations: - name: getstorefrontaccesstokens method: GET description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued outputRawFormat: json outputParameters: - name: result type: object value: $. - 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-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-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-2021-01-application_charges.json path: /admin/api/2021-01/application_charges.json operations: - name: deprecated202101getapplicationcharges method: GET description: Shopify Retrieves A List Of Application Charges 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: A comma-separated list of fields to include in the response. - 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-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-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-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-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-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-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-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-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-customers.json path: /admin/api/2021-01/customers.json operations: - name: deprecated202101getcustomers method: GET description: Shopify Retrieves A List Of Customers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Restrict results to customers specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to those after the specified ID. - name: created_at_min in: query type: string description: 'Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)' - 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: deprecated202101deletecustomersparamcustomeridaddressesparamaddressid method: DELETE description: Shopify Removes An Address From A Customer’s Address List 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-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-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-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_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-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-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-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-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-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-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-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-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-recurring_application_charges.json path: /admin/api/2021-01/recurring_application_charges.json operations: - name: deprecated202101getrecurringapplicationcharges method: GET description: Shopify Retrieves A List Of Recurring Application Charges 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: A comma-separated list of fields to include in the response. - name: admin-api-2021-01-recurring_application_charges-recurring_application_charge_id- path: /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json operations: - name: deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges method: GET description: Shopify Retrieves A List Of Usage Charges outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: recurring_application_charge_id in: path type: string description: recurring_application_charge_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-reports.json path: /admin/api/2021-01/reports.json operations: - name: deprecated202101getreports method: GET description: Shopify Retrieves A List Of Reports outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: A comma-separated list of report IDs. - name: limit in: query type: string description: The amount of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_min in: query type: string description: 'Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show reports last updated before 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: 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-shipping_zones.json path: /admin/api/2021-01/shipping_zones.json operations: - name: deprecated202101getshippingzones method: GET description: Shopify Get A List Of All Shipping Zones outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: comma-separated list of fields to include in the response - 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-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-storefront_access_tokens.json path: /admin/api/2021-01/storefront_access_tokens.json operations: - name: deprecated202101getstorefrontaccesstokens method: GET description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued outputRawFormat: json outputParameters: - name: result type: object value: $. - 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-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-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-unstable-application_charges.json path: /admin/api/unstable/application_charges.json operations: - name: deprecatedunstablegetapplicationcharges method: GET description: Shopify Retrieves A List Of Application Charges 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: A comma-separated list of fields to include in the response. - 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-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-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-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-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-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-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-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-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-customers.json path: /admin/api/unstable/customers.json operations: - name: deprecatedunstablegetcustomers method: GET description: Shopify Retrieves A List Of Customers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: Restrict results to customers specified by a comma-separated list of IDs. - name: since_id in: query type: string description: Restrict results to those after the specified ID. - name: created_at_min in: query type: string description: 'Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: created_at_max in: query type: string description: 'Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_min in: query type: string description: 'Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)' - 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-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: deprecatedunstabledeletecustomersparamcustomeridaddressesparamaddressid method: DELETE description: Shopify Removes An Address From A Customer’s Address List 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-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-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-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-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_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-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-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-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-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-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-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-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-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-recurring_application_charges.json path: /admin/api/unstable/recurring_application_charges.json operations: - name: deprecatedunstablegetrecurringapplicationcharges method: GET description: Shopify Retrieves A List Of Recurring Application Charges 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: A comma-separated list of fields to include in the response. - name: admin-api-unstable-recurring_application_charges-recurring_application_charge_id path: /admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json operations: - name: deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges method: GET description: Shopify Retrieves A List Of Usage Charges outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: recurring_application_charge_id in: path type: string description: recurring_application_charge_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-reports.json path: /admin/api/unstable/reports.json operations: - name: deprecatedunstablegetreports method: GET description: Shopify Retrieves A List Of Reports outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: string description: A comma-separated list of report IDs. - name: limit in: query type: string description: The amount of results to return. - name: since_id in: query type: string description: Restrict results to after the specified ID. - name: updated_at_min in: query type: string description: 'Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)' - name: updated_at_max in: query type: string description: 'Show reports last updated before 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: 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-shipping_zones.json path: /admin/api/unstable/shipping_zones.json operations: - name: deprecatedunstablegetshippingzones method: GET description: Shopify Get A List Of All Shipping Zones outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: fields in: query type: string description: comma-separated list of fields to include in the response - 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-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-storefront_access_tokens.json path: /admin/api/unstable/storefront_access_tokens.json operations: - name: deprecatedunstablegetstorefrontaccesstokens method: GET description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued outputRawFormat: json outputParameters: - name: result type: object value: $. - 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-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-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-oauth-access_scopes.json path: /admin/oauth/access_scopes.json operations: - name: getadminoauthaccessscopes method: GET description: Shopify Retrieves A List Of Access Scopes Associated To The Access Token outputRawFormat: json outputParameters: - name: result type: object value: $. exposes: - type: rest namespace: shopify-lists-rest port: 8080 description: REST adapter for Shopify API — Lists. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/admin/api/2020-01/application-charges-json name: admin-api-2020-01-application-charges-json description: REST surface for admin-api-2020-01-application_charges.json. operations: - method: GET name: deprecated202001getapplicationcharges description: Shopify Retrieves A List Of Application Charges call: shopify-lists.deprecated202001getapplicationcharges with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - 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-lists.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-lists.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-lists.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-lists.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-lists.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/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-lists.deprecated202001getcarrierservices 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-lists.deprecated202001getcheckoutsparamtokenpayments with: token: rest.token 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-lists.deprecated202001getcheckoutsparamtokenshippingrates with: token: rest.token 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-lists.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-lists.deprecated202001getcollects with: limit: rest.limit since_id: rest.since_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-lists.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/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-lists.deprecated202001getcountries with: since_id: rest.since_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-lists.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/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-lists.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-lists.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/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-lists.deprecated202001getcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customers-json name: admin-api-2020-01-customers-json description: REST surface for admin-api-2020-01-customers.json. operations: - method: GET name: deprecated202001getcustomers description: Shopify Retrieves A List Of Customers call: shopify-lists.deprecated202001getcustomers with: ids: rest.ids 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 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-lists.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: DELETE name: deprecated202001deletecustomersparamcustomeridaddressesparamaddressid description: Shopify Removes An Address From A Customer’s Address List call: shopify-lists.deprecated202001deletecustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id 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-lists.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/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-lists.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-lists.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/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-lists.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-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-lists.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-lists.deprecated202001getlocations 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-lists.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-lists.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/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-lists.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/{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-lists.deprecated202001getordersparamorderidfulfillmentorders with: order_id: rest.order_id 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-lists.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}/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-lists.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}/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-lists.deprecated202001getordersparamorderidrisks with: order_id: rest.order_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-lists.deprecated202001getpolicies 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-lists.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-lists.deprecated202001getpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_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-lists.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/recurring-application-charges-json name: admin-api-2020-01-recurring-application-charges-json description: REST surface for admin-api-2020-01-recurring_application_charges.json. operations: - method: GET name: deprecated202001getrecurringapplicationcharges description: Shopify Retrieves A List Of Recurring Application Charges call: shopify-lists.deprecated202001getrecurringapplicationcharges with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/recurring-application-charges/{recurring-application-charge-id}/usage-charges-json name: admin-api-2020-01-recurring-application-charges-recurring-application-charge-id description: REST surface for admin-api-2020-01-recurring_application_charges-recurring_application_charge_id-. operations: - method: GET name: deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges description: Shopify Retrieves A List Of Usage Charges call: shopify-lists.deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: rest.recurring_application_charge_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-lists.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/reports-json name: admin-api-2020-01-reports-json description: REST surface for admin-api-2020-01-reports.json. operations: - method: GET name: deprecated202001getreports description: Shopify Retrieves A List Of Reports call: shopify-lists.deprecated202001getreports with: ids: rest.ids limit: rest.limit since_id: rest.since_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max 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-lists.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/shipping-zones-json name: admin-api-2020-01-shipping-zones-json description: REST surface for admin-api-2020-01-shipping_zones.json. operations: - method: GET name: deprecated202001getshippingzones description: Shopify Get A List Of All Shipping Zones call: shopify-lists.deprecated202001getshippingzones with: fields: rest.fields 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-lists.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/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-lists.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/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-lists.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/storefront-access-tokens-json name: admin-api-2020-01-storefront-access-tokens-json description: REST surface for admin-api-2020-01-storefront_access_tokens.json. operations: - method: GET name: deprecated202001getstorefrontaccesstokens description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued call: shopify-lists.deprecated202001getstorefrontaccesstokens 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-lists.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-lists.deprecated202001getthemes with: fields: rest.fields 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-lists.deprecated202001getusers with: limit: rest.limit page_info: rest.page_info 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-lists.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-04/application-charges-json name: admin-api-2020-04-application-charges-json description: REST surface for admin-api-2020-04-application_charges.json. operations: - method: GET name: deprecated202004getapplicationcharges description: Shopify Retrieves A List Of Application Charges call: shopify-lists.deprecated202004getapplicationcharges with: since_id: rest.since_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-lists.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-lists.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-lists.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-lists.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/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-lists.deprecated202004getcarrierservices 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-lists.deprecated202004getcheckoutsparamtokenpayments with: token: rest.token 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-lists.deprecated202004getcheckoutsparamtokenshippingrates with: token: rest.token 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-lists.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-lists.deprecated202004getcollects with: limit: rest.limit since_id: rest.since_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-lists.deprecated202004getcountries with: since_id: rest.since_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-lists.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/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-lists.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-lists.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/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-lists.deprecated202004getcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customers-json name: admin-api-2020-04-customers-json description: REST surface for admin-api-2020-04-customers.json. operations: - method: GET name: deprecated202004getcustomers description: Shopify Retrieves A List Of Customers call: shopify-lists.deprecated202004getcustomers with: ids: rest.ids 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 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-lists.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: DELETE name: deprecated202004deletecustomersparamcustomeridaddressesparamaddressid description: Shopify Removes An Address From A Customer’s Address List call: shopify-lists.deprecated202004deletecustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id 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-lists.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/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-lists.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-lists.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/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-lists.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-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-lists.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-lists.deprecated202004getlocations 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-lists.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-lists.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/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-lists.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/{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-lists.deprecated202004getordersparamorderidfulfillmentorders with: order_id: rest.order_id 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-lists.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}/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-lists.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}/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-lists.deprecated202004getordersparamorderidrisks with: order_id: rest.order_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-lists.deprecated202004getpolicies 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-lists.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-lists.deprecated202004getpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_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-lists.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/recurring-application-charges-json name: admin-api-2020-04-recurring-application-charges-json description: REST surface for admin-api-2020-04-recurring_application_charges.json. operations: - method: GET name: deprecated202004getrecurringapplicationcharges description: Shopify Retrieves A List Of Recurring Application Charges call: shopify-lists.deprecated202004getrecurringapplicationcharges with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/recurring-application-charges/{recurring-application-charge-id}/usage-charges-json name: admin-api-2020-04-recurring-application-charges-recurring-application-charge-id description: REST surface for admin-api-2020-04-recurring_application_charges-recurring_application_charge_id-. operations: - method: GET name: deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges description: Shopify Retrieves A List Of Usage Charges call: shopify-lists.deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: rest.recurring_application_charge_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-lists.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/reports-json name: admin-api-2020-04-reports-json description: REST surface for admin-api-2020-04-reports.json. operations: - method: GET name: deprecated202004getreports description: Shopify Retrieves A List Of Reports call: shopify-lists.deprecated202004getreports with: ids: rest.ids limit: rest.limit since_id: rest.since_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max 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-lists.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/shipping-zones-json name: admin-api-2020-04-shipping-zones-json description: REST surface for admin-api-2020-04-shipping_zones.json. operations: - method: GET name: deprecated202004getshippingzones description: Shopify Get A List Of All Shipping Zones call: shopify-lists.deprecated202004getshippingzones with: fields: rest.fields 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-lists.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/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-lists.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/storefront-access-tokens-json name: admin-api-2020-04-storefront-access-tokens-json description: REST surface for admin-api-2020-04-storefront_access_tokens.json. operations: - method: GET name: deprecated202004getstorefrontaccesstokens description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued call: shopify-lists.deprecated202004getstorefrontaccesstokens 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-lists.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-lists.deprecated202004getthemes with: fields: rest.fields 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-lists.deprecated202004getusers with: limit: rest.limit page_info: rest.page_info 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-lists.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-07/application-charges-json name: admin-api-2020-07-application-charges-json description: REST surface for admin-api-2020-07-application_charges.json. operations: - method: GET name: deprecated202007getapplicationcharges description: Shopify Retrieves A List Of Application Charges call: shopify-lists.deprecated202007getapplicationcharges with: since_id: rest.since_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-lists.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-lists.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-lists.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-lists.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/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-lists.deprecated202007getcarrierservices 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-lists.deprecated202007getcheckoutsparamtokenpayments with: token: rest.token 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-lists.deprecated202007getcheckoutsparamtokenshippingrates with: token: rest.token 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-lists.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-lists.deprecated202007getcollects with: limit: rest.limit since_id: rest.since_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-lists.deprecated202007getcountries with: since_id: rest.since_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-lists.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/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-lists.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-lists.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/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-lists.deprecated202007getcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customers-json name: admin-api-2020-07-customers-json description: REST surface for admin-api-2020-07-customers.json. operations: - method: GET name: deprecated202007getcustomers description: Shopify Retrieves A List Of Customers call: shopify-lists.deprecated202007getcustomers with: ids: rest.ids 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 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-lists.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: DELETE name: deprecated202007deletecustomersparamcustomeridaddressesparamaddressid description: Shopify Removes An Address From A Customer’s Address List call: shopify-lists.deprecated202007deletecustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id 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-lists.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/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-lists.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-lists.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/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-lists.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-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-lists.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-lists.deprecated202007getlocations 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-lists.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-lists.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/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-lists.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-lists.deprecated202007getordersparamorderidfulfillmentorders with: order_id: rest.order_id 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-lists.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}/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-lists.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}/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-lists.deprecated202007getordersparamorderidrisks with: order_id: rest.order_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-lists.deprecated202007getpolicies 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-lists.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-lists.deprecated202007getpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_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-lists.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/recurring-application-charges-json name: admin-api-2020-07-recurring-application-charges-json description: REST surface for admin-api-2020-07-recurring_application_charges.json. operations: - method: GET name: deprecated202007getrecurringapplicationcharges description: Shopify Retrieves A List Of Recurring Application Charges call: shopify-lists.deprecated202007getrecurringapplicationcharges with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/recurring-application-charges/{recurring-application-charge-id}/usage-charges-json name: admin-api-2020-07-recurring-application-charges-recurring-application-charge-id description: REST surface for admin-api-2020-07-recurring_application_charges-recurring_application_charge_id-. operations: - method: GET name: deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges description: Shopify Retrieves A List Of Usage Charges call: shopify-lists.deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: rest.recurring_application_charge_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-lists.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/reports-json name: admin-api-2020-07-reports-json description: REST surface for admin-api-2020-07-reports.json. operations: - method: GET name: deprecated202007getreports description: Shopify Retrieves A List Of Reports call: shopify-lists.deprecated202007getreports with: ids: rest.ids limit: rest.limit since_id: rest.since_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max 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-lists.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/shipping-zones-json name: admin-api-2020-07-shipping-zones-json description: REST surface for admin-api-2020-07-shipping_zones.json. operations: - method: GET name: deprecated202007getshippingzones description: Shopify Get A List Of All Shipping Zones call: shopify-lists.deprecated202007getshippingzones with: fields: rest.fields 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-lists.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/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-lists.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/storefront-access-tokens-json name: admin-api-2020-07-storefront-access-tokens-json description: REST surface for admin-api-2020-07-storefront_access_tokens.json. operations: - method: GET name: deprecated202007getstorefrontaccesstokens description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued call: shopify-lists.deprecated202007getstorefrontaccesstokens 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-lists.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-lists.deprecated202007getthemes with: fields: rest.fields 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-lists.deprecated202007getusers with: limit: rest.limit page_info: rest.page_info 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-lists.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-10/application-charges-json name: admin-api-2020-10-application-charges-json description: REST surface for admin-api-2020-10-application_charges.json. operations: - method: GET name: getapplicationcharges description: Shopify Retrieves A List Of Application Charges call: shopify-lists.getapplicationcharges with: since_id: rest.since_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-lists.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-lists.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-lists.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-lists.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/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-lists.getcarrierservices 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-lists.getcheckoutsparamtokenpayments with: token: rest.token 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-lists.getcheckoutsparamtokenshippingrates with: token: rest.token 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-lists.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-lists.getcollects with: limit: rest.limit since_id: rest.since_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-lists.getcountries with: since_id: rest.since_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-lists.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/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-lists.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-lists.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/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-lists.getcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customers-json name: admin-api-2020-10-customers-json description: REST surface for admin-api-2020-10-customers.json. operations: - method: GET name: getcustomers description: Shopify Retrieves A List Of Customers call: shopify-lists.getcustomers with: ids: rest.ids 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 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-lists.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: DELETE name: deletecustomersparamcustomeridaddressesparamaddressid description: Shopify Removes An Address From A Customer’s Address List call: shopify-lists.deletecustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id 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-lists.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/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-lists.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-lists.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/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-lists.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-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-lists.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-lists.getlocations 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-lists.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-lists.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/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-lists.getordersparamorderidfulfillmentorders with: order_id: rest.order_id 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-lists.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}/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-lists.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}/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-lists.getordersparamorderidrisks with: order_id: rest.order_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-lists.getpolicies 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-lists.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-lists.getpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_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-lists.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/recurring-application-charges-json name: admin-api-2020-10-recurring-application-charges-json description: REST surface for admin-api-2020-10-recurring_application_charges.json. operations: - method: GET name: getrecurringapplicationcharges description: Shopify Retrieves A List Of Recurring Application Charges call: shopify-lists.getrecurringapplicationcharges with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/recurring-application-charges/{recurring-application-charge-id}/usage-charges-json name: admin-api-2020-10-recurring-application-charges-recurring-application-charge-id description: REST surface for admin-api-2020-10-recurring_application_charges-recurring_application_charge_id-. operations: - method: GET name: getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges description: Shopify Retrieves A List Of Usage Charges call: shopify-lists.getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: rest.recurring_application_charge_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-lists.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/reports-json name: admin-api-2020-10-reports-json description: REST surface for admin-api-2020-10-reports.json. operations: - method: GET name: getreports description: Shopify Retrieves A List Of Reports call: shopify-lists.getreports with: ids: rest.ids limit: rest.limit since_id: rest.since_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max 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-lists.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/shipping-zones-json name: admin-api-2020-10-shipping-zones-json description: REST surface for admin-api-2020-10-shipping_zones.json. operations: - method: GET name: getshippingzones description: Shopify Get A List Of All Shipping Zones call: shopify-lists.getshippingzones with: fields: rest.fields 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-lists.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/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-lists.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/storefront-access-tokens-json name: admin-api-2020-10-storefront-access-tokens-json description: REST surface for admin-api-2020-10-storefront_access_tokens.json. operations: - method: GET name: getstorefrontaccesstokens description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued call: shopify-lists.getstorefrontaccesstokens 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-lists.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-lists.getthemes with: fields: rest.fields 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-lists.getusers with: limit: rest.limit page_info: rest.page_info 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-lists.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/2021-01/application-charges-json name: admin-api-2021-01-application-charges-json description: REST surface for admin-api-2021-01-application_charges.json. operations: - method: GET name: deprecated202101getapplicationcharges description: Shopify Retrieves A List Of Application Charges call: shopify-lists.deprecated202101getapplicationcharges with: since_id: rest.since_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-lists.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-lists.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-lists.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-lists.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/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-lists.deprecated202101getcarrierservices 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-lists.deprecated202101getcheckoutsparamtokenpayments with: token: rest.token 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-lists.deprecated202101getcheckoutsparamtokenshippingrates with: token: rest.token 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-lists.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-lists.deprecated202101getcollects with: limit: rest.limit since_id: rest.since_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-lists.deprecated202101getcountries with: since_id: rest.since_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-lists.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/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-lists.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-lists.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/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-lists.deprecated202101getcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customers-json name: admin-api-2021-01-customers-json description: REST surface for admin-api-2021-01-customers.json. operations: - method: GET name: deprecated202101getcustomers description: Shopify Retrieves A List Of Customers call: shopify-lists.deprecated202101getcustomers with: ids: rest.ids 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 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-lists.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: DELETE name: deprecated202101deletecustomersparamcustomeridaddressesparamaddressid description: Shopify Removes An Address From A Customer’s Address List call: shopify-lists.deprecated202101deletecustomersparamcustomeridaddressesparamaddressid 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-lists.deprecated202101getdeprecatedapicalls 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-lists.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/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-lists.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-lists.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/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-lists.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-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-lists.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-lists.deprecated202101getlocations 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-lists.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-lists.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/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-lists.deprecated202101getordersparamorderidfulfillmentorders with: order_id: rest.order_id 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-lists.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}/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-lists.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}/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-lists.deprecated202101getordersparamorderidrisks with: order_id: rest.order_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-lists.deprecated202101getpolicies 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-lists.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-lists.deprecated202101getpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_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-lists.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/recurring-application-charges-json name: admin-api-2021-01-recurring-application-charges-json description: REST surface for admin-api-2021-01-recurring_application_charges.json. operations: - method: GET name: deprecated202101getrecurringapplicationcharges description: Shopify Retrieves A List Of Recurring Application Charges call: shopify-lists.deprecated202101getrecurringapplicationcharges with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/recurring-application-charges/{recurring-application-charge-id}/usage-charges-json name: admin-api-2021-01-recurring-application-charges-recurring-application-charge-id description: REST surface for admin-api-2021-01-recurring_application_charges-recurring_application_charge_id-. operations: - method: GET name: deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges description: Shopify Retrieves A List Of Usage Charges call: shopify-lists.deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: rest.recurring_application_charge_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-lists.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/reports-json name: admin-api-2021-01-reports-json description: REST surface for admin-api-2021-01-reports.json. operations: - method: GET name: deprecated202101getreports description: Shopify Retrieves A List Of Reports call: shopify-lists.deprecated202101getreports with: ids: rest.ids limit: rest.limit since_id: rest.since_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max 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-lists.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/shipping-zones-json name: admin-api-2021-01-shipping-zones-json description: REST surface for admin-api-2021-01-shipping_zones.json. operations: - method: GET name: deprecated202101getshippingzones description: Shopify Get A List Of All Shipping Zones call: shopify-lists.deprecated202101getshippingzones with: fields: rest.fields 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-lists.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/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-lists.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/storefront-access-tokens-json name: admin-api-2021-01-storefront-access-tokens-json description: REST surface for admin-api-2021-01-storefront_access_tokens.json. operations: - method: GET name: deprecated202101getstorefrontaccesstokens description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued call: shopify-lists.deprecated202101getstorefrontaccesstokens 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-lists.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-lists.deprecated202101getthemes with: fields: rest.fields 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-lists.deprecated202101getusers with: limit: rest.limit page_info: rest.page_info 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-lists.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/unstable/application-charges-json name: admin-api-unstable-application-charges-json description: REST surface for admin-api-unstable-application_charges.json. operations: - method: GET name: deprecatedunstablegetapplicationcharges description: Shopify Retrieves A List Of Application Charges call: shopify-lists.deprecatedunstablegetapplicationcharges with: since_id: rest.since_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-lists.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-lists.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-lists.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-lists.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/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-lists.deprecatedunstablegetcarrierservices 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-lists.deprecatedunstablegetcheckoutsparamtokenpayments with: token: rest.token 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-lists.deprecatedunstablegetcheckoutsparamtokenshippingrates with: token: rest.token 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-lists.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-lists.deprecatedunstablegetcollects with: limit: rest.limit since_id: rest.since_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-lists.deprecatedunstablegetcountries with: since_id: rest.since_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-lists.deprecatedunstablegetcountriesparamcountryidprovinces with: country_id: rest.country_id since_id: rest.since_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-lists.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-lists.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/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-lists.deprecatedunstablegetcustomersavedsearches with: limit: rest.limit since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customers-json name: admin-api-unstable-customers-json description: REST surface for admin-api-unstable-customers.json. operations: - method: GET name: deprecatedunstablegetcustomers description: Shopify Retrieves A List Of Customers call: shopify-lists.deprecatedunstablegetcustomers with: ids: rest.ids 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 limit: rest.limit fields: rest.fields 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-lists.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: DELETE name: deprecatedunstabledeletecustomersparamcustomeridaddressesparamaddressid description: Shopify Removes An Address From A Customer’s Address List call: shopify-lists.deprecatedunstabledeletecustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_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-lists.deprecatedunstablegetdeprecatedapicalls 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-lists.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/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-lists.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-lists.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/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-lists.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-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-lists.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-lists.deprecatedunstablegetlocations 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-lists.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-lists.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/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-lists.deprecatedunstablegetordersparamorderidfulfillmentorders with: order_id: rest.order_id 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-lists.deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: rest.order_id fulfillment_id: rest.fulfillment_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-lists.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}/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-lists.deprecatedunstablegetordersparamorderidrisks with: order_id: rest.order_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-lists.deprecatedunstablegetpolicies 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-lists.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-lists.deprecatedunstablegetpricerulesparampriceruleiddiscountcodes with: price_rule_id: rest.price_rule_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-lists.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/recurring-application-charges-json name: admin-api-unstable-recurring-application-charges-json description: REST surface for admin-api-unstable-recurring_application_charges.json. operations: - method: GET name: deprecatedunstablegetrecurringapplicationcharges description: Shopify Retrieves A List Of Recurring Application Charges call: shopify-lists.deprecatedunstablegetrecurringapplicationcharges with: since_id: rest.since_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/recurring-application-charges/{recurring-application-charge-id}/usage-charges-json name: admin-api-unstable-recurring-application-charges-recurring-application-charge-id description: REST surface for admin-api-unstable-recurring_application_charges-recurring_application_charge_id. operations: - method: GET name: deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges description: Shopify Retrieves A List Of Usage Charges call: shopify-lists.deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: rest.recurring_application_charge_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-lists.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/reports-json name: admin-api-unstable-reports-json description: REST surface for admin-api-unstable-reports.json. operations: - method: GET name: deprecatedunstablegetreports description: Shopify Retrieves A List Of Reports call: shopify-lists.deprecatedunstablegetreports with: ids: rest.ids limit: rest.limit since_id: rest.since_id updated_at_min: rest.updated_at_min updated_at_max: rest.updated_at_max 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-lists.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/shipping-zones-json name: admin-api-unstable-shipping-zones-json description: REST surface for admin-api-unstable-shipping_zones.json. operations: - method: GET name: deprecatedunstablegetshippingzones description: Shopify Get A List Of All Shipping Zones call: shopify-lists.deprecatedunstablegetshippingzones with: fields: rest.fields 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-lists.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/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-lists.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/storefront-access-tokens-json name: admin-api-unstable-storefront-access-tokens-json description: REST surface for admin-api-unstable-storefront_access_tokens.json. operations: - method: GET name: deprecatedunstablegetstorefrontaccesstokens description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued call: shopify-lists.deprecatedunstablegetstorefrontaccesstokens 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-lists.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-lists.deprecatedunstablegetthemes with: fields: rest.fields 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-lists.deprecatedunstablegetusers with: limit: rest.limit page_info: rest.page_info 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-lists.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/oauth/access-scopes-json name: admin-oauth-access-scopes-json description: REST surface for admin-oauth-access_scopes.json. operations: - method: GET name: getadminoauthaccessscopes description: Shopify Retrieves A List Of Access Scopes Associated To The Access Token call: shopify-lists.getadminoauthaccessscopes outputParameters: - type: object mapping: $. - type: mcp namespace: shopify-lists-mcp port: 9090 transport: http description: MCP adapter for Shopify API — Lists. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: shopify-retrieves-list-application-charges description: Shopify Retrieves A List Of Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getapplicationcharges with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-all-article description: Shopify Retrieves A List All Of Article Authors hints: readOnly: true destructive: false idempotent: true call: shopify-lists.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-lists.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-lists.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-lists.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-lists.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-list-carrier-services description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getcarrierservices 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-lists.deprecated202001getcheckoutsparamtokenpayments with: token: tools.token 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-lists.deprecated202001getcheckoutsparamtokenshippingrates with: token: tools.token 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-lists.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-lists.deprecated202001getcollects with: limit: tools.limit since_id: tools.since_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-lists.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-list-countries description: Shopify Retrieves A List Of Countries hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getcountries with: since_id: tools.since_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-lists.deprecated202001getcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_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-lists.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-lists.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-list-customer-saved description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customers description: Shopify Retrieves A List Of Customers hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getcustomers with: ids: tools.ids 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 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-lists.deprecated202001getcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-removes-address-customer-s-address description: Shopify Removes An Address From A Customer’s Address List hints: readOnly: false destructive: true idempotent: true call: shopify-lists.deprecated202001deletecustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id 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-lists.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-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-lists.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-lists.deprecated202001getgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields 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-lists.deprecated202001getinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids 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-lists.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-lists.deprecated202001getlocations 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-lists.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-lists.deprecated202001getmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] 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-lists.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-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-lists.deprecated202001getordersparamorderidfulfillmentorders with: order_id: tools.order_id 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-lists.deprecated202001getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_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-lists.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-list-all-order description: Shopify Retrieves A List Of All Order Risks For An Order hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getordersparamorderidrisks with: order_id: tools.order_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-lists.deprecated202001getpolicies 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-lists.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-lists.deprecated202001getpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_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-lists.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-list-recurring-application description: Shopify Retrieves A List Of Recurring Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getrecurringapplicationcharges with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-usage-charges description: Shopify Retrieves A List Of Usage Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: tools.recurring_application_charge_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-lists.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-list-reports description: Shopify Retrieves A List Of Reports hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getreports with: ids: tools.ids limit: tools.limit since_id: tools.since_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max 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-lists.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-get-list-all-shipping description: Shopify Get A List Of All Shipping Zones hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getshippingzones with: fields: tools.fields 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-lists.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-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-lists.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-list-smart-collections description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-lists.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-list-storefront-access description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202001getstorefrontaccesstokens 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-lists.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-lists.deprecated202001getthemes with: fields: tools.fields 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-lists.deprecated202001getusers with: limit: tools.limit page_info: tools.page_info 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-lists.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-list-application-charges-2 description: Shopify Retrieves A List Of Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202004getapplicationcharges with: since_id: tools.since_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-lists.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-lists.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-lists.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-lists.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-list-carrier-services-2 description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202004getcarrierservices 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-lists.deprecated202004getcheckoutsparamtokenpayments with: token: tools.token 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-lists.deprecated202004getcheckoutsparamtokenshippingrates with: token: tools.token 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-lists.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-lists.deprecated202004getcollects with: limit: tools.limit since_id: tools.since_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-lists.deprecated202004getcountries with: since_id: tools.since_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-lists.deprecated202004getcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_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-lists.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-lists.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-list-customer-saved-2 description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202004getcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customers-2 description: Shopify Retrieves A List Of Customers hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202004getcustomers with: ids: tools.ids 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 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-lists.deprecated202004getcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-removes-address-customer-s-address-2 description: Shopify Removes An Address From A Customer’s Address List hints: readOnly: false destructive: true idempotent: true call: shopify-lists.deprecated202004deletecustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id 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-lists.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-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-lists.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-lists.deprecated202004getgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields 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-lists.deprecated202004getinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids 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-lists.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-lists.deprecated202004getlocations 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-lists.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-lists.deprecated202004getmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] 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-lists.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-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-lists.deprecated202004getordersparamorderidfulfillmentorders with: order_id: tools.order_id 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-lists.deprecated202004getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_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-lists.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-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-lists.deprecated202004getordersparamorderidrisks with: order_id: tools.order_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-lists.deprecated202004getpolicies 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-lists.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-lists.deprecated202004getpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_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-lists.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-list-recurring-application-2 description: Shopify Retrieves A List Of Recurring Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202004getrecurringapplicationcharges with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-usage-charges-2 description: Shopify Retrieves A List Of Usage Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: tools.recurring_application_charge_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-lists.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-list-reports-2 description: Shopify Retrieves A List Of Reports hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202004getreports with: ids: tools.ids limit: tools.limit since_id: tools.since_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max 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-lists.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-get-list-all-shipping-2 description: Shopify Get A List Of All Shipping Zones hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202004getshippingzones with: fields: tools.fields 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-lists.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-list-smart-collections-2 description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-lists.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-list-storefront-access-2 description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202004getstorefrontaccesstokens 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-lists.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-lists.deprecated202004getthemes with: fields: tools.fields 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-lists.deprecated202004getusers with: limit: tools.limit page_info: tools.page_info 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-lists.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-list-application-charges-3 description: Shopify Retrieves A List Of Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202007getapplicationcharges with: since_id: tools.since_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-lists.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-lists.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-lists.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-lists.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-list-carrier-services-3 description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202007getcarrierservices 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-lists.deprecated202007getcheckoutsparamtokenpayments with: token: tools.token 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-lists.deprecated202007getcheckoutsparamtokenshippingrates with: token: tools.token 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-lists.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-lists.deprecated202007getcollects with: limit: tools.limit since_id: tools.since_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-lists.deprecated202007getcountries with: since_id: tools.since_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-lists.deprecated202007getcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_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-lists.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-lists.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-list-customer-saved-3 description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202007getcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customers-3 description: Shopify Retrieves A List Of Customers hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202007getcustomers with: ids: tools.ids 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 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-lists.deprecated202007getcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-removes-address-customer-s-address-3 description: Shopify Removes An Address From A Customer’s Address List hints: readOnly: false destructive: true idempotent: true call: shopify-lists.deprecated202007deletecustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id 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-lists.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-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-lists.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-lists.deprecated202007getgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields 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-lists.deprecated202007getinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids 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-lists.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-lists.deprecated202007getlocations 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-lists.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-lists.deprecated202007getmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] 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-lists.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-lists.deprecated202007getordersparamorderidfulfillmentorders with: order_id: tools.order_id 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-lists.deprecated202007getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_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-lists.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-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-lists.deprecated202007getordersparamorderidrisks with: order_id: tools.order_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-lists.deprecated202007getpolicies 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-lists.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-lists.deprecated202007getpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_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-lists.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-list-recurring-application-3 description: Shopify Retrieves A List Of Recurring Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202007getrecurringapplicationcharges with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-usage-charges-3 description: Shopify Retrieves A List Of Usage Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: tools.recurring_application_charge_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-lists.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-list-reports-3 description: Shopify Retrieves A List Of Reports hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202007getreports with: ids: tools.ids limit: tools.limit since_id: tools.since_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max 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-lists.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-get-list-all-shipping-3 description: Shopify Get A List Of All Shipping Zones hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202007getshippingzones with: fields: tools.fields 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-lists.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-list-smart-collections-3 description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-lists.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-list-storefront-access-3 description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202007getstorefrontaccesstokens 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-lists.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-lists.deprecated202007getthemes with: fields: tools.fields 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-lists.deprecated202007getusers with: limit: tools.limit page_info: tools.page_info 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-lists.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-list-application-charges-4 description: Shopify Retrieves A List Of Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.getapplicationcharges with: since_id: tools.since_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-lists.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-lists.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-lists.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-lists.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-list-carrier-services-4 description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-lists.getcarrierservices 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-lists.getcheckoutsparamtokenpayments with: token: tools.token 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-lists.getcheckoutsparamtokenshippingrates with: token: tools.token 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-lists.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-lists.getcollects with: limit: tools.limit since_id: tools.since_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-lists.getcountries with: since_id: tools.since_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-lists.getcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_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-lists.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-lists.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-list-customer-saved-4 description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-lists.getcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customers-4 description: Shopify Retrieves A List Of Customers hints: readOnly: true destructive: false idempotent: true call: shopify-lists.getcustomers with: ids: tools.ids 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 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-lists.getcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-removes-address-customer-s-address-4 description: Shopify Removes An Address From A Customer’s Address List hints: readOnly: false destructive: true idempotent: true call: shopify-lists.deletecustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id 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-lists.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-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-lists.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-lists.getgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields 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-lists.getinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids 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-lists.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-lists.getlocations 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-lists.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-lists.getmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] 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-lists.getordersparamorderidfulfillmentorders with: order_id: tools.order_id 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-lists.getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_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-lists.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-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-lists.getordersparamorderidrisks with: order_id: tools.order_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-lists.getpolicies 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-lists.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-lists.getpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_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-lists.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-list-recurring-application-4 description: Shopify Retrieves A List Of Recurring Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.getrecurringapplicationcharges with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-usage-charges-4 description: Shopify Retrieves A List Of Usage Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: tools.recurring_application_charge_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-lists.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-list-reports-4 description: Shopify Retrieves A List Of Reports hints: readOnly: true destructive: false idempotent: true call: shopify-lists.getreports with: ids: tools.ids limit: tools.limit since_id: tools.since_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max 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-lists.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-get-list-all-shipping-4 description: Shopify Get A List Of All Shipping Zones hints: readOnly: true destructive: false idempotent: true call: shopify-lists.getshippingzones with: fields: tools.fields 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-lists.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-list-smart-collections-4 description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-lists.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-list-storefront-access-4 description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued hints: readOnly: true destructive: false idempotent: true call: shopify-lists.getstorefrontaccesstokens 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-lists.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-lists.getthemes with: fields: tools.fields 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-lists.getusers with: limit: tools.limit page_info: tools.page_info 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-lists.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-list-application-charges-5 description: Shopify Retrieves A List Of Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202101getapplicationcharges with: since_id: tools.since_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-lists.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-lists.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-lists.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-lists.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-list-carrier-services-5 description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202101getcarrierservices 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-lists.deprecated202101getcheckoutsparamtokenpayments with: token: tools.token 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-lists.deprecated202101getcheckoutsparamtokenshippingrates with: token: tools.token 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-lists.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-lists.deprecated202101getcollects with: limit: tools.limit since_id: tools.since_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-lists.deprecated202101getcountries with: since_id: tools.since_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-lists.deprecated202101getcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_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-lists.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-lists.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-list-customer-saved-5 description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202101getcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customers-5 description: Shopify Retrieves A List Of Customers hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202101getcustomers with: ids: tools.ids 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 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-lists.deprecated202101getcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-removes-address-customer-s-address-5 description: Shopify Removes An Address From A Customer’s Address List hints: readOnly: false destructive: true idempotent: true call: shopify-lists.deprecated202101deletecustomersparamcustomeridaddressesparamaddressid 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-lists.deprecated202101getdeprecatedapicalls 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-lists.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-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-lists.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-lists.deprecated202101getgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields 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-lists.deprecated202101getinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids 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-lists.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-lists.deprecated202101getlocations 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-lists.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-lists.deprecated202101getmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] 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-lists.deprecated202101getordersparamorderidfulfillmentorders with: order_id: tools.order_id 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-lists.deprecated202101getordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_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-lists.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-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-lists.deprecated202101getordersparamorderidrisks with: order_id: tools.order_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-lists.deprecated202101getpolicies 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-lists.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-lists.deprecated202101getpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_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-lists.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-list-recurring-application-5 description: Shopify Retrieves A List Of Recurring Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202101getrecurringapplicationcharges with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-usage-charges-5 description: Shopify Retrieves A List Of Usage Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: tools.recurring_application_charge_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-lists.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-list-reports-5 description: Shopify Retrieves A List Of Reports hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202101getreports with: ids: tools.ids limit: tools.limit since_id: tools.since_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max 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-lists.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-get-list-all-shipping-5 description: Shopify Get A List Of All Shipping Zones hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202101getshippingzones with: fields: tools.fields 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-lists.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-list-smart-collections-5 description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-lists.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-list-storefront-access-5 description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecated202101getstorefrontaccesstokens 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-lists.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-lists.deprecated202101getthemes with: fields: tools.fields 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-lists.deprecated202101getusers with: limit: tools.limit page_info: tools.page_info 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-lists.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-list-application-charges-6 description: Shopify Retrieves A List Of Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecatedunstablegetapplicationcharges with: since_id: tools.since_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-lists.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-lists.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-lists.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-lists.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-list-carrier-services-6 description: Shopify Retrieves A List Of Carrier Services hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecatedunstablegetcarrierservices 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-lists.deprecatedunstablegetcheckoutsparamtokenpayments with: token: tools.token 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-lists.deprecatedunstablegetcheckoutsparamtokenshippingrates with: token: tools.token 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-lists.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-lists.deprecatedunstablegetcollects with: limit: tools.limit since_id: tools.since_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-lists.deprecatedunstablegetcountries with: since_id: tools.since_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-lists.deprecatedunstablegetcountriesparamcountryidprovinces with: country_id: tools.country_id since_id: tools.since_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-lists.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-lists.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-list-customer-saved-6 description: Shopify Retrieves A List Of Customer Saved Searches hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecatedunstablegetcustomersavedsearches with: limit: tools.limit since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-customers-6 description: Shopify Retrieves A List Of Customers hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecatedunstablegetcustomers with: ids: tools.ids 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 limit: tools.limit fields: tools.fields 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-lists.deprecatedunstablegetcustomersparamcustomeridaddresses with: customer_id: tools.customer_id outputParameters: - type: object mapping: $. - name: shopify-removes-address-customer-s-address-6 description: Shopify Removes An Address From A Customer’s Address List hints: readOnly: false destructive: true idempotent: true call: shopify-lists.deprecatedunstabledeletecustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_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-lists.deprecatedunstablegetdeprecatedapicalls 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-lists.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-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-lists.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-lists.deprecatedunstablegetgiftcards with: status: tools.status limit: tools.limit since_id: tools.since_id fields: tools.fields 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-lists.deprecatedunstablegetinventoryitems with: ? "ids\n required" : "tools.ids\n required" limit: tools.limit ids: tools.ids 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-lists.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-lists.deprecatedunstablegetlocations 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-lists.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-lists.deprecatedunstablegetmetafields with: metafield[owner_id]: tools.metafield[owner_id] metafield[owner_resource]: tools.metafield[owner_resource] 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-lists.deprecatedunstablegetordersparamorderidfulfillmentorders with: order_id: tools.order_id 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-lists.deprecatedunstablegetordersparamorderidfulfillmentsparamfulfillmentidevents with: order_id: tools.order_id fulfillment_id: tools.fulfillment_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-lists.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-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-lists.deprecatedunstablegetordersparamorderidrisks with: order_id: tools.order_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-lists.deprecatedunstablegetpolicies 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-lists.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-lists.deprecatedunstablegetpricerulesparampriceruleiddiscountcodes with: price_rule_id: tools.price_rule_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-lists.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-list-recurring-application-6 description: Shopify Retrieves A List Of Recurring Application Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecatedunstablegetrecurringapplicationcharges with: since_id: tools.since_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-list-usage-charges-6 description: Shopify Retrieves A List Of Usage Charges hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeidusagecharges with: recurring_application_charge_id: tools.recurring_application_charge_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-lists.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-list-reports-6 description: Shopify Retrieves A List Of Reports hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecatedunstablegetreports with: ids: tools.ids limit: tools.limit since_id: tools.since_id updated_at_min: tools.updated_at_min updated_at_max: tools.updated_at_max 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-lists.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-get-list-all-shipping-6 description: Shopify Get A List Of All Shipping Zones hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecatedunstablegetshippingzones with: fields: tools.fields 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-lists.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-list-smart-collections-6 description: Shopify Retrieves A List Of Smart Collections hints: readOnly: true destructive: false idempotent: true call: shopify-lists.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-list-storefront-access-6 description: Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued hints: readOnly: true destructive: false idempotent: true call: shopify-lists.deprecatedunstablegetstorefrontaccesstokens 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-lists.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-lists.deprecatedunstablegetthemes with: fields: tools.fields 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-lists.deprecatedunstablegetusers with: limit: tools.limit page_info: tools.page_info 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-lists.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-list-access-scopes description: Shopify Retrieves A List Of Access Scopes Associated To The Access Token hints: readOnly: true destructive: false idempotent: true call: shopify-lists.getadminoauthaccessscopes outputParameters: - type: object mapping: $.