naftiko: 1.0.0-alpha2 info: label: Shopify API — Single description: 'Shopify API — Single. 183 operations. Lead operation: Shopify Retrieves A Single Application Credit. Self-contained Naftiko capability covering one Shopify business surface.' tags: - Shopify - Single created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: SHOPIFY_API_KEY: SHOPIFY_API_KEY capability: consumes: - type: http namespace: shopify-single baseUri: '' description: Shopify API — Single business capability. Self-contained, no shared references. resources: - name: admin-api-2020-01-application_credits-application_credit_id}.json path: /admin/api/2020-01/application_credits/{application_credit_id}.json operations: - name: deprecated202001getapplicationcreditsparamapplicationcreditid method: GET description: Shopify Retrieves A Single Application Credit outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: application_credit_id in: path type: string description: application_credit_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-blogs-blog_id}.json path: /admin/api/2020-01/blogs/{blog_id}.json operations: - name: deprecated202001getblogsparamblogid method: GET description: Shopify Get A Single Blog By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: fields in: query type: string description: comma-separated list of fields to include in the response - name: admin-api-2020-01-blogs-blog_id-articles-article_id}.json path: /admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.json operations: - name: deprecated202001getblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-2020-01-carrier_services-carrier_service_id}.json path: /admin/api/2020-01/carrier_services/{carrier_service_id}.json operations: - name: deprecated202001getcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-2020-01-collections-collection_id}.json path: /admin/api/2020-01/collections/{collection_id}.json operations: - name: deprecated202001getcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-comments-comment_id}.json path: /admin/api/2020-01/comments/{comment_id}.json operations: - name: deprecated202001getcommentsparamcommentid method: GET description: Shopify Retrieves A Single Comment By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: comment_id in: path type: string description: comment_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-countries-country_id-provinces-province_id}.json path: /admin/api/2020-01/countries/{country_id}/provinces/{province_id}.json operations: - name: deprecated202001getcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-custom_collections-custom_collection_id}.json path: /admin/api/2020-01/custom_collections/{custom_collection_id}.json operations: - name: deprecated202001getcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json operations: - name: deprecated202001getcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-customers-customer_id}.json path: /admin/api/2020-01/customers/{customer_id}.json operations: - name: deprecated202001getcustomersparamcustomerid method: GET description: Shopify Retrieves A Single Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-customers-customer_id-addresses-address_id}.json path: /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json operations: - name: deprecated202001getcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-2020-01-events-event_id}.json path: /admin/api/2020-01/events/{event_id}.json operations: - name: deprecated202001geteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-gift_cards-gift_card_id}.json path: /admin/api/2020-01/gift_cards/{gift_card_id}.json operations: - name: deprecated202001getgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-2020-01-inventory_items-inventory_item_id}.json path: /admin/api/2020-01/inventory_items/{inventory_item_id}.json operations: - name: deprecated202001getinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-2020-01-inventory_levels-adjust.json path: /admin/api/2020-01/inventory_levels/adjust.json operations: - name: deprecated202001createinventorylevelsadjust method: POST description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "inventory_item_id\n required" in: query type: string description: The ID of the inventory item. - name: "location_id\n required" in: query type: string description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource. - name: "available_adjustment\n required" in: query type: string description: The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, "available_adjustment" - name: body in: body type: object description: Request body (JSON). required: false - name: admin-api-2020-01-locations-location_id}.json path: /admin/api/2020-01/locations/{location_id}.json operations: - name: deprecated202001getlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-01-metafields-metafield_id}.json path: /admin/api/2020-01/metafields/{metafield_id}.json operations: - name: deprecated202001getmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-orders-order_id-risks-risk_id}.json path: /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json operations: - name: deprecated202001getordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-2020-01-price_rules-price_rule_id-discount_codes-discount_code_id}.jso path: /admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: deprecated202001getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-2020-01-products-product_id}.json path: /admin/api/2020-01/products/{product_id}.json operations: - name: deprecated202001getproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-01-products-product_id-images-image_id}.json path: /admin/api/2020-01/products/{product_id}/images/{image_id}.json operations: - name: deprecated202001getproductsparamproductidimagesparamimageid method: GET description: Shopify Get A Single Product Image By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: image_id in: path type: string description: image_id required: true - name: fields in: query type: string description: comma-separated list of fields to include in the response - name: admin-api-2020-01-recurring_application_charges-recurring_application_charge_id} path: /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}.json operations: - name: deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeid method: GET description: Shopify Retrieves A Single Charge 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-recurring_application_charges-recurring_application_charge_id- path: /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json operations: - name: deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid method: GET description: Shopify Retrieves A Single Charge 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: usage_charge_id in: path type: string description: usage_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-redirect_id}.json path: /admin/api/2020-01/redirects/{redirect_id}.json operations: - name: deprecated202001getredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-reports-report_id}.json path: /admin/api/2020-01/reports/{report_id}.json operations: - name: deprecated202001getreportsparamreportid method: GET description: Shopify Retrieves A Single Report Created By Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: report_id in: path type: string description: report_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-script_tags-script_tag_id}.json path: /admin/api/2020-01/script_tags/{script_tag_id}.json operations: - name: deprecated202001getscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-01-shopify_payments-disputes-dispute_id}.json path: /admin/api/2020-01/shopify_payments/disputes/{dispute_id}.json operations: - name: deprecated202001getshopifypaymentsdisputesparamdisputeid method: GET description: Shopify Retrieves A Single Dispute By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: dispute_id in: path type: string description: dispute_id required: true - name: admin-api-2020-01-shopify_payments-payouts-payout_id}.json path: /admin/api/2020-01/shopify_payments/payouts/{payout_id}.json operations: - name: deprecated202001getshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-2020-01-smart_collections-smart_collection_id}.json path: /admin/api/2020-01/smart_collections/{smart_collection_id}.json operations: - name: deprecated202001getsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-themes-theme_id}.json path: /admin/api/2020-01/themes/{theme_id}.json operations: - name: deprecated202001getthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-01-themes-theme_id-assets.json path: /admin/api/2020-01/themes/{theme_id}/assets.json operations: - name: deprecated202001getthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-2020-01-users-user_id}.json path: /admin/api/2020-01/users/{user_id}.json operations: - name: deprecated202001getusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-2020-01-webhooks-webhook_id}.json path: /admin/api/2020-01/webhooks/{webhook_id}.json operations: - name: deprecated202001getwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: admin-api-2020-04-application_credits-application_credit_id}.json path: /admin/api/2020-04/application_credits/{application_credit_id}.json operations: - name: deprecated202004getapplicationcreditsparamapplicationcreditid method: GET description: Shopify Retrieves A Single Application Credit outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: application_credit_id in: path type: string description: application_credit_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-blogs-blog_id-articles-article_id}.json path: /admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.json operations: - name: deprecated202004getblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-2020-04-carrier_services-carrier_service_id}.json path: /admin/api/2020-04/carrier_services/{carrier_service_id}.json operations: - name: deprecated202004getcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-2020-04-collections-collection_id}.json path: /admin/api/2020-04/collections/{collection_id}.json operations: - name: deprecated202004getcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-countries-country_id-provinces-province_id}.json path: /admin/api/2020-04/countries/{country_id}/provinces/{province_id}.json operations: - name: deprecated202004getcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-custom_collections-custom_collection_id}.json path: /admin/api/2020-04/custom_collections/{custom_collection_id}.json operations: - name: deprecated202004getcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json operations: - name: deprecated202004getcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-customers-customer_id}.json path: /admin/api/2020-04/customers/{customer_id}.json operations: - name: deprecated202004getcustomersparamcustomerid method: GET description: Shopify Retrieves A Single Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-customers-customer_id-addresses-address_id}.json path: /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json operations: - name: deprecated202004getcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-2020-04-events-event_id}.json path: /admin/api/2020-04/events/{event_id}.json operations: - name: deprecated202004geteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-gift_cards-gift_card_id}.json path: /admin/api/2020-04/gift_cards/{gift_card_id}.json operations: - name: deprecated202004getgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-2020-04-inventory_items-inventory_item_id}.json path: /admin/api/2020-04/inventory_items/{inventory_item_id}.json operations: - name: deprecated202004getinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-2020-04-inventory_levels-adjust.json path: /admin/api/2020-04/inventory_levels/adjust.json operations: - name: deprecated202004createinventorylevelsadjust method: POST description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "inventory_item_id\n required" in: query type: string description: The ID of the inventory item. - name: "location_id\n required" in: query type: string description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource. - name: "available_adjustment\n required" in: query type: string description: The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, "available_adjustment" - name: body in: body type: object description: Request body (JSON). required: false - name: admin-api-2020-04-locations-location_id}.json path: /admin/api/2020-04/locations/{location_id}.json operations: - name: deprecated202004getlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-04-metafields-metafield_id}.json path: /admin/api/2020-04/metafields/{metafield_id}.json operations: - name: deprecated202004getmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-orders-order_id-risks-risk_id}.json path: /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json operations: - name: deprecated202004getordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-2020-04-price_rules-price_rule_id-discount_codes-discount_code_id}.jso path: /admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: deprecated202004getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-2020-04-products-product_id}.json path: /admin/api/2020-04/products/{product_id}.json operations: - name: deprecated202004getproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-04-products-product_id-images-image_id}.json path: /admin/api/2020-04/products/{product_id}/images/{image_id}.json operations: - name: deprecated202004getproductsparamproductidimagesparamimageid method: GET description: Shopify Get A Single Product Image By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: image_id in: path type: string description: image_id required: true - name: fields in: query type: string description: comma-separated list of fields to include in the response - name: admin-api-2020-04-recurring_application_charges-recurring_application_charge_id} path: /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}.json operations: - name: deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeid method: GET description: Shopify Retrieves A Single Charge 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-recurring_application_charges-recurring_application_charge_id- path: /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json operations: - name: deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid method: GET description: Shopify Retrieves A Single Charge 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: usage_charge_id in: path type: string description: usage_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-redirect_id}.json path: /admin/api/2020-04/redirects/{redirect_id}.json operations: - name: deprecated202004getredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-reports-report_id}.json path: /admin/api/2020-04/reports/{report_id}.json operations: - name: deprecated202004getreportsparamreportid method: GET description: Shopify Retrieves A Single Report Created By Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: report_id in: path type: string description: report_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-script_tags-script_tag_id}.json path: /admin/api/2020-04/script_tags/{script_tag_id}.json operations: - name: deprecated202004getscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-04-shopify_payments-payouts-payout_id}.json path: /admin/api/2020-04/shopify_payments/payouts/{payout_id}.json operations: - name: deprecated202004getshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-2020-04-smart_collections-smart_collection_id}.json path: /admin/api/2020-04/smart_collections/{smart_collection_id}.json operations: - name: deprecated202004getsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-themes-theme_id}.json path: /admin/api/2020-04/themes/{theme_id}.json operations: - name: deprecated202004getthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-04-themes-theme_id-assets.json path: /admin/api/2020-04/themes/{theme_id}/assets.json operations: - name: deprecated202004getthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-2020-04-users-user_id}.json path: /admin/api/2020-04/users/{user_id}.json operations: - name: deprecated202004getusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-2020-04-webhooks-webhook_id}.json path: /admin/api/2020-04/webhooks/{webhook_id}.json operations: - name: deprecated202004getwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: admin-api-2020-07-application_credits-application_credit_id}.json path: /admin/api/2020-07/application_credits/{application_credit_id}.json operations: - name: deprecated202007getapplicationcreditsparamapplicationcreditid method: GET description: Shopify Retrieves A Single Application Credit outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: application_credit_id in: path type: string description: application_credit_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-blogs-blog_id-articles-article_id}.json path: /admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.json operations: - name: deprecated202007getblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-2020-07-carrier_services-carrier_service_id}.json path: /admin/api/2020-07/carrier_services/{carrier_service_id}.json operations: - name: deprecated202007getcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-2020-07-collections-collection_id}.json path: /admin/api/2020-07/collections/{collection_id}.json operations: - name: deprecated202007getcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-countries-country_id-provinces-province_id}.json path: /admin/api/2020-07/countries/{country_id}/provinces/{province_id}.json operations: - name: deprecated202007getcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-custom_collections-custom_collection_id}.json path: /admin/api/2020-07/custom_collections/{custom_collection_id}.json operations: - name: deprecated202007getcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json operations: - name: deprecated202007getcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-customers-customer_id}.json path: /admin/api/2020-07/customers/{customer_id}.json operations: - name: deprecated202007getcustomersparamcustomerid method: GET description: Shopify Retrieves A Single Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-customers-customer_id-addresses-address_id}.json path: /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json operations: - name: deprecated202007getcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-2020-07-events-event_id}.json path: /admin/api/2020-07/events/{event_id}.json operations: - name: deprecated202007geteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-gift_cards-gift_card_id}.json path: /admin/api/2020-07/gift_cards/{gift_card_id}.json operations: - name: deprecated202007getgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-2020-07-inventory_items-inventory_item_id}.json path: /admin/api/2020-07/inventory_items/{inventory_item_id}.json operations: - name: deprecated202007getinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-2020-07-inventory_levels-adjust.json path: /admin/api/2020-07/inventory_levels/adjust.json operations: - name: deprecated202007createinventorylevelsadjust method: POST description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "inventory_item_id\n required" in: query type: string description: The ID of the inventory item. - name: "location_id\n required" in: query type: string description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource. - name: "available_adjustment\n required" in: query type: string description: The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, "available_adjustment" - name: body in: body type: object description: Request body (JSON). required: false - name: admin-api-2020-07-locations-location_id}.json path: /admin/api/2020-07/locations/{location_id}.json operations: - name: deprecated202007getlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-07-metafields-metafield_id}.json path: /admin/api/2020-07/metafields/{metafield_id}.json operations: - name: deprecated202007getmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-orders-order_id-risks-risk_id}.json path: /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json operations: - name: deprecated202007getordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-2020-07-price_rules-price_rule_id-discount_codes-discount_code_id}.jso path: /admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: deprecated202007getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-2020-07-products-product_id}.json path: /admin/api/2020-07/products/{product_id}.json operations: - name: deprecated202007getproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-07-products-product_id-images-image_id}.json path: /admin/api/2020-07/products/{product_id}/images/{image_id}.json operations: - name: deprecated202007getproductsparamproductidimagesparamimageid method: GET description: Shopify Get A Single Product Image By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: image_id in: path type: string description: image_id required: true - name: fields in: query type: string description: comma-separated list of fields to include in the response - name: admin-api-2020-07-recurring_application_charges-recurring_application_charge_id} path: /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}.json operations: - name: deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeid method: GET description: Shopify Retrieves A Single Charge 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-recurring_application_charges-recurring_application_charge_id- path: /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json operations: - name: deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid method: GET description: Shopify Retrieves A Single Charge 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: usage_charge_id in: path type: string description: usage_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-redirect_id}.json path: /admin/api/2020-07/redirects/{redirect_id}.json operations: - name: deprecated202007getredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-reports-report_id}.json path: /admin/api/2020-07/reports/{report_id}.json operations: - name: deprecated202007getreportsparamreportid method: GET description: Shopify Retrieves A Single Report Created By Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: report_id in: path type: string description: report_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-script_tags-script_tag_id}.json path: /admin/api/2020-07/script_tags/{script_tag_id}.json operations: - name: deprecated202007getscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-07-shopify_payments-payouts-payout_id}.json path: /admin/api/2020-07/shopify_payments/payouts/{payout_id}.json operations: - name: deprecated202007getshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-2020-07-smart_collections-smart_collection_id}.json path: /admin/api/2020-07/smart_collections/{smart_collection_id}.json operations: - name: deprecated202007getsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-themes-theme_id}.json path: /admin/api/2020-07/themes/{theme_id}.json operations: - name: deprecated202007getthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-07-themes-theme_id-assets.json path: /admin/api/2020-07/themes/{theme_id}/assets.json operations: - name: deprecated202007getthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-2020-07-users-user_id}.json path: /admin/api/2020-07/users/{user_id}.json operations: - name: deprecated202007getusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-2020-07-webhooks-webhook_id}.json path: /admin/api/2020-07/webhooks/{webhook_id}.json operations: - name: deprecated202007getwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: admin-api-2020-10-application_credits-application_credit_id}.json path: /admin/api/2020-10/application_credits/{application_credit_id}.json operations: - name: getapplicationcreditsparamapplicationcreditid method: GET description: Shopify Retrieves A Single Application Credit outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: application_credit_id in: path type: string description: application_credit_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-blogs-blog_id-articles-article_id}.json path: /admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.json operations: - name: getblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-2020-10-carrier_services-carrier_service_id}.json path: /admin/api/2020-10/carrier_services/{carrier_service_id}.json operations: - name: getcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-2020-10-collections-collection_id}.json path: /admin/api/2020-10/collections/{collection_id}.json operations: - name: getcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-countries-country_id-provinces-province_id}.json path: /admin/api/2020-10/countries/{country_id}/provinces/{province_id}.json operations: - name: getcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-custom_collections-custom_collection_id}.json path: /admin/api/2020-10/custom_collections/{custom_collection_id}.json operations: - name: getcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json operations: - name: getcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-customers-customer_id}.json path: /admin/api/2020-10/customers/{customer_id}.json operations: - name: getcustomersparamcustomerid method: GET description: Shopify Retrieves A Single Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-customers-customer_id-addresses-address_id}.json path: /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json operations: - name: getcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-2020-10-events-event_id}.json path: /admin/api/2020-10/events/{event_id}.json operations: - name: geteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-gift_cards-gift_card_id}.json path: /admin/api/2020-10/gift_cards/{gift_card_id}.json operations: - name: getgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-2020-10-inventory_items-inventory_item_id}.json path: /admin/api/2020-10/inventory_items/{inventory_item_id}.json operations: - name: getinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-2020-10-inventory_levels-adjust.json path: /admin/api/2020-10/inventory_levels/adjust.json operations: - name: createinventorylevelsadjust method: POST description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "inventory_item_id\n required" in: query type: string description: The ID of the inventory item. - name: "location_id\n required" in: query type: string description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource. - name: "available_adjustment\n required" in: query type: string description: The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, "available_adjustment" - name: body in: body type: object description: Request body (JSON). required: false - name: admin-api-2020-10-locations-location_id}.json path: /admin/api/2020-10/locations/{location_id}.json operations: - name: getlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2020-10-metafields-metafield_id}.json path: /admin/api/2020-10/metafields/{metafield_id}.json operations: - name: getmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-orders-order_id-risks-risk_id}.json path: /admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json operations: - name: getordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-2020-10-price_rules-price_rule_id-discount_codes-discount_code_id}.jso path: /admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-2020-10-products-product_id}.json path: /admin/api/2020-10/products/{product_id}.json operations: - name: getproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-10-products-product_id-images-image_id}.json path: /admin/api/2020-10/products/{product_id}/images/{image_id}.json operations: - name: getproductsparamproductidimagesparamimageid method: GET description: Shopify Get A Single Product Image By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: image_id in: path type: string description: image_id required: true - name: fields in: query type: string description: comma-separated list of fields to include in the response - name: admin-api-2020-10-recurring_application_charges-recurring_application_charge_id} path: /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}.json operations: - name: getrecurringapplicationchargesparamrecurringapplicationchargeid method: GET description: Shopify Retrieves A Single Charge 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-recurring_application_charges-recurring_application_charge_id- path: /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json operations: - name: getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid method: GET description: Shopify Retrieves A Single Charge 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: usage_charge_id in: path type: string description: usage_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-redirect_id}.json path: /admin/api/2020-10/redirects/{redirect_id}.json operations: - name: getredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-reports-report_id}.json path: /admin/api/2020-10/reports/{report_id}.json operations: - name: getreportsparamreportid method: GET description: Shopify Retrieves A Single Report Created By Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: report_id in: path type: string description: report_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-script_tags-script_tag_id}.json path: /admin/api/2020-10/script_tags/{script_tag_id}.json operations: - name: getscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2020-10-shopify_payments-payouts-payout_id}.json path: /admin/api/2020-10/shopify_payments/payouts/{payout_id}.json operations: - name: getshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-2020-10-smart_collections-smart_collection_id}.json path: /admin/api/2020-10/smart_collections/{smart_collection_id}.json operations: - name: getsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-themes-theme_id}.json path: /admin/api/2020-10/themes/{theme_id}.json operations: - name: getthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2020-10-themes-theme_id-assets.json path: /admin/api/2020-10/themes/{theme_id}/assets.json operations: - name: getthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-2020-10-users-user_id}.json path: /admin/api/2020-10/users/{user_id}.json operations: - name: getusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-2020-10-webhooks-webhook_id}.json path: /admin/api/2020-10/webhooks/{webhook_id}.json operations: - name: getwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: admin-api-2021-01-application_credits-application_credit_id}.json path: /admin/api/2021-01/application_credits/{application_credit_id}.json operations: - name: deprecated202101getapplicationcreditsparamapplicationcreditid method: GET description: Shopify Retrieves A Single Application Credit outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: application_credit_id in: path type: string description: application_credit_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-blogs-blog_id-articles-article_id}.json path: /admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.json operations: - name: deprecated202101getblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-2021-01-carrier_services-carrier_service_id}.json path: /admin/api/2021-01/carrier_services/{carrier_service_id}.json operations: - name: deprecated202101getcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-2021-01-collections-collection_id}.json path: /admin/api/2021-01/collections/{collection_id}.json operations: - name: deprecated202101getcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-countries-country_id-provinces-province_id}.json path: /admin/api/2021-01/countries/{country_id}/provinces/{province_id}.json operations: - name: deprecated202101getcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-custom_collections-custom_collection_id}.json path: /admin/api/2021-01/custom_collections/{custom_collection_id}.json operations: - name: deprecated202101getcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json operations: - name: deprecated202101getcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-customers-customer_id}.json path: /admin/api/2021-01/customers/{customer_id}.json operations: - name: deprecated202101getcustomersparamcustomerid method: GET description: Shopify Retrieves A Single Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-customers-customer_id-addresses-address_id}.json path: /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json operations: - name: deprecated202101getcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-2021-01-events-event_id}.json path: /admin/api/2021-01/events/{event_id}.json operations: - name: deprecated202101geteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-gift_cards-gift_card_id}.json path: /admin/api/2021-01/gift_cards/{gift_card_id}.json operations: - name: deprecated202101getgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-2021-01-inventory_items-inventory_item_id}.json path: /admin/api/2021-01/inventory_items/{inventory_item_id}.json operations: - name: deprecated202101getinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-2021-01-inventory_levels-adjust.json path: /admin/api/2021-01/inventory_levels/adjust.json operations: - name: deprecated202101createinventorylevelsadjust method: POST description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "inventory_item_id\n required" in: query type: string description: The ID of the inventory item. - name: "location_id\n required" in: query type: string description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource. - name: "available_adjustment\n required" in: query type: string description: The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, "available_adjustment" - name: body in: body type: object description: Request body (JSON). required: false - name: admin-api-2021-01-locations-location_id}.json path: /admin/api/2021-01/locations/{location_id}.json operations: - name: deprecated202101getlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-2021-01-metafields-metafield_id}.json path: /admin/api/2021-01/metafields/{metafield_id}.json operations: - name: deprecated202101getmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-orders-order_id-risks-risk_id}.json path: /admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json operations: - name: deprecated202101getordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-2021-01-price_rules-price_rule_id-discount_codes-discount_code_id}.jso path: /admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: deprecated202101getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-2021-01-products-product_id}.json path: /admin/api/2021-01/products/{product_id}.json operations: - name: deprecated202101getproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2021-01-products-product_id-images-image_id}.json path: /admin/api/2021-01/products/{product_id}/images/{image_id}.json operations: - name: deprecated202101getproductsparamproductidimagesparamimageid method: GET description: Shopify Get A Single Product Image By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: image_id in: path type: string description: image_id required: true - name: fields in: query type: string description: comma-separated list of fields to include in the response - name: admin-api-2021-01-recurring_application_charges-recurring_application_charge_id} path: /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}.json operations: - name: deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeid method: GET description: Shopify Retrieves A Single Charge 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-recurring_application_charges-recurring_application_charge_id- path: /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json operations: - name: deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid method: GET description: Shopify Retrieves A Single Charge 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: usage_charge_id in: path type: string description: usage_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-redirect_id}.json path: /admin/api/2021-01/redirects/{redirect_id}.json operations: - name: deprecated202101getredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-reports-report_id}.json path: /admin/api/2021-01/reports/{report_id}.json operations: - name: deprecated202101getreportsparamreportid method: GET description: Shopify Retrieves A Single Report Created By Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: report_id in: path type: string description: report_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-script_tags-script_tag_id}.json path: /admin/api/2021-01/script_tags/{script_tag_id}.json operations: - name: deprecated202101getscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-2021-01-shopify_payments-payouts-payout_id}.json path: /admin/api/2021-01/shopify_payments/payouts/{payout_id}.json operations: - name: deprecated202101getshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-2021-01-smart_collections-smart_collection_id}.json path: /admin/api/2021-01/smart_collections/{smart_collection_id}.json operations: - name: deprecated202101getsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-themes-theme_id}.json path: /admin/api/2021-01/themes/{theme_id}.json operations: - name: deprecated202101getthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-2021-01-themes-theme_id-assets.json path: /admin/api/2021-01/themes/{theme_id}/assets.json operations: - name: deprecated202101getthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-2021-01-users-user_id}.json path: /admin/api/2021-01/users/{user_id}.json operations: - name: deprecated202101getusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-2021-01-webhooks-webhook_id}.json path: /admin/api/2021-01/webhooks/{webhook_id}.json operations: - name: deprecated202101getwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho - name: admin-api-unstable-application_credits-application_credit_id}.json path: /admin/api/unstable/application_credits/{application_credit_id}.json operations: - name: deprecatedunstablegetapplicationcreditsparamapplicationcreditid method: GET description: Shopify Retrieves A Single Application Credit outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: application_credit_id in: path type: string description: application_credit_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-blogs-blog_id-articles-article_id}.json path: /admin/api/unstable/blogs/{blog_id}/articles/{article_id}.json operations: - name: deprecatedunstablegetblogsparamblogidarticlesparamarticleid method: GET description: Shopify Retrieves A Single Article outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: blog_id in: path type: string description: blog_id required: true - name: article_id in: path type: string description: article_id required: true - name: fields in: query type: string description: Show only certain fields, specifed by a comma-separated list of field names. - name: admin-api-unstable-carrier_services-carrier_service_id}.json path: /admin/api/unstable/carrier_services/{carrier_service_id}.json operations: - name: deprecatedunstablegetcarrierservicesparamcarrierserviceid method: GET description: Shopify Retrieves A Single Carrier Service By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: carrier_service_id in: path type: string description: carrier_service_id required: true - name: admin-api-unstable-collections-collection_id}.json path: /admin/api/unstable/collections/{collection_id}.json operations: - name: deprecatedunstablegetcollectionsparamcollectionid method: GET description: Shopify Retrieves A Single Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: collection_id in: path type: string description: collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-countries-country_id-provinces-province_id}.json path: /admin/api/unstable/countries/{country_id}/provinces/{province_id}.json operations: - name: deprecatedunstablegetcountriesparamcountryidprovincesparamprovinceid method: GET description: Shopify Retrieves A Single Province For A Country outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: country_id in: path type: string description: country_id required: true - name: province_id in: path type: string description: province_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-custom_collections-custom_collection_id}.json path: /admin/api/unstable/custom_collections/{custom_collection_id}.json operations: - name: deprecatedunstablegetcustomcollectionsparamcustomcollectionid method: GET description: Shopify Retrieves A Single Custom Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: custom_collection_id in: path type: string description: custom_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-customer_saved_searches-customer_saved_search_id}.json path: /admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.json operations: - name: deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchid method: GET description: Shopify Retrieves A Single Customer Saved Search outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_saved_search_id in: path type: string description: customer_saved_search_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-customers-customer_id}.json path: /admin/api/unstable/customers/{customer_id}.json operations: - name: deprecatedunstablegetcustomersparamcustomerid method: GET description: Shopify Retrieves A Single Customer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-customers-customer_id-addresses-address_id}.json path: /admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json operations: - name: deprecatedunstablegetcustomersparamcustomeridaddressesparamaddressid method: GET description: Shopify Retrieves Details A Single Customer Address outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: customer_id in: path type: string description: customer_id required: true - name: address_id in: path type: string description: address_id required: true - name: admin-api-unstable-events-event_id}.json path: /admin/api/unstable/events/{event_id}.json operations: - name: deprecatedunstablegeteventsparameventid method: GET description: Shopify Retrieves A Single Event By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: event_id in: path type: string description: event_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-gift_cards-gift_card_id}.json path: /admin/api/unstable/gift_cards/{gift_card_id}.json operations: - name: deprecatedunstablegetgiftcardsparamgiftcardid method: GET description: Shopify Retrieves A Single Gift Card By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: gift_card_id in: path type: string description: gift_card_id required: true - name: admin-api-unstable-inventory_items-inventory_item_id}.json path: /admin/api/unstable/inventory_items/{inventory_item_id}.json operations: - name: deprecatedunstablegetinventoryitemsparaminventoryitemid method: GET description: Shopify Retrieves A Single Inventory Item By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: inventory_item_id in: path type: string description: inventory_item_id required: true - name: admin-api-unstable-inventory_levels-adjust.json path: /admin/api/unstable/inventory_levels/adjust.json operations: - name: deprecatedunstablecreateinventorylevelsadjust method: POST description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: "inventory_item_id\n required" in: query type: string description: The ID of the inventory item. - name: "location_id\n required" in: query type: string description: The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource. - name: "available_adjustment\n required" in: query type: string description: The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, "available_adjustment" - name: body in: body type: object description: Request body (JSON). required: false - name: admin-api-unstable-locations-location_id}.json path: /admin/api/unstable/locations/{location_id}.json operations: - name: deprecatedunstablegetlocationsparamlocationid method: GET description: Shopify Retrieves A Single Location By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: location_id in: path type: string description: location_id required: true - name: admin-api-unstable-metafields-metafield_id}.json path: /admin/api/unstable/metafields/{metafield_id}.json operations: - name: deprecatedunstablegetmetafieldsparammetafieldid method: GET description: Shopify Retrieves A Single Metafield From A Resource By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: metafield_id in: path type: string description: metafield_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-orders-order_id-risks-risk_id}.json path: /admin/api/unstable/orders/{order_id}/risks/{risk_id}.json operations: - name: deprecatedunstablegetordersparamorderidrisksparamriskid method: GET description: Shopify Retrieves A Single Order Risk By Its Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: order_id in: path type: string description: order_id required: true - name: risk_id in: path type: string description: risk_id required: true - name: admin-api-unstable-price_rules-price_rule_id-discount_codes-discount_code_id}.js path: /admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json operations: - name: deprecatedunstablegetpricerulesparampriceruleiddiscountcodesparamdiscountcodeid method: GET description: Shopify Retrieves A Single Discount Code outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: price_rule_id in: path type: string description: price_rule_id required: true - name: discount_code_id in: path type: string description: discount_code_id required: true - name: admin-api-unstable-products-product_id}.json path: /admin/api/unstable/products/{product_id}.json operations: - name: deprecatedunstablegetproductsparamproductid method: GET description: Shopify Retrieves A Single Product outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-unstable-products-product_id-images-image_id}.json path: /admin/api/unstable/products/{product_id}/images/{image_id}.json operations: - name: deprecatedunstablegetproductsparamproductidimagesparamimageid method: GET description: Shopify Get A Single Product Image By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: product_id in: path type: string description: product_id required: true - name: image_id in: path type: string description: image_id required: true - name: fields in: query type: string description: 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}.json operations: - name: deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeid method: GET description: Shopify Retrieves A Single Charge 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-recurring_application_charges-recurring_application_charge_id path: /admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json operations: - name: deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid method: GET description: Shopify Retrieves A Single Charge 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: usage_charge_id in: path type: string description: usage_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-redirect_id}.json path: /admin/api/unstable/redirects/{redirect_id}.json operations: - name: deprecatedunstablegetredirectsparamredirectid method: GET description: Shopify Retrieves A Single Redirect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: redirect_id in: path type: string description: redirect_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-reports-report_id}.json path: /admin/api/unstable/reports/{report_id}.json operations: - name: deprecatedunstablegetreportsparamreportid method: GET description: Shopify Retrieves A Single Report Created By Your App outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: report_id in: path type: string description: report_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-script_tags-script_tag_id}.json path: /admin/api/unstable/script_tags/{script_tag_id}.json operations: - name: deprecatedunstablegetscripttagsparamscripttagid method: GET description: Shopify Retrieves A Single Script Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: script_tag_id in: path type: string description: script_tag_id required: true - name: fields in: query type: string description: A comma-separated list of fields to include in the response. - name: admin-api-unstable-shopify_payments-payouts-payout_id}.json path: /admin/api/unstable/shopify_payments/payouts/{payout_id}.json operations: - name: deprecatedunstablegetshopifypaymentspayoutsparampayoutid method: GET description: Shopify Retrieves A Single Payout By Id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payout_id in: path type: string description: payout_id required: true - name: admin-api-unstable-smart_collections-smart_collection_id}.json path: /admin/api/unstable/smart_collections/{smart_collection_id}.json operations: - name: deprecatedunstablegetsmartcollectionsparamsmartcollectionid method: GET description: Shopify Retrieves A Single Smart Collection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: smart_collection_id in: path type: string description: smart_collection_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-themes-theme_id}.json path: /admin/api/unstable/themes/{theme_id}.json operations: - name: deprecatedunstablegetthemesparamthemeid method: GET description: Shopify Retrieves A Single Theme outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names. - name: admin-api-unstable-themes-theme_id-assets.json path: /admin/api/unstable/themes/{theme_id}/assets.json operations: - name: deprecatedunstablegetthemesparamthemeidassets method: GET description: Shopify Retrieves A Single Asset For A Theme By Its Key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: theme_id in: path type: string description: theme_id required: true - name: fields in: query type: string description: Show only certain fields, specified by a comma-separated list of field names - name: asset[key] in: query type: string description: asset[key] - name: admin-api-unstable-users-user_id}.json path: /admin/api/unstable/users/{user_id}.json operations: - name: deprecatedunstablegetusersparamuserid method: GET description: Shopify Retrieves A Single User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string description: user_id required: true - name: admin-api-unstable-webhooks-webhook_id}.json path: /admin/api/unstable/webhooks/{webhook_id}.json operations: - name: deprecatedunstablegetwebhooksparamwebhookid method: GET description: Shopify Retrieves A Single Webhook Subscription outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: webhook_id in: path type: string description: webhook_id required: true - name: fields in: query type: string description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only tho exposes: - type: rest namespace: shopify-single-rest port: 8080 description: REST adapter for Shopify API — Single. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/admin/api/2020-01/application-credits/application-credit-id-json name: admin-api-2020-01-application-credits-application-credit-id-json description: REST surface for admin-api-2020-01-application_credits-application_credit_id}.json. operations: - method: GET name: deprecated202001getapplicationcreditsparamapplicationcreditid description: Shopify Retrieves A Single Application Credit call: shopify-single.deprecated202001getapplicationcreditsparamapplicationcreditid with: application_credit_id: rest.application_credit_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/blogs/blog-id-json name: admin-api-2020-01-blogs-blog-id-json description: REST surface for admin-api-2020-01-blogs-blog_id}.json. operations: - method: GET name: deprecated202001getblogsparamblogid description: Shopify Get A Single Blog By Its Id call: shopify-single.deprecated202001getblogsparamblogid with: blog_id: rest.blog_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/blogs/{blog-id}/articles/article-id-json name: admin-api-2020-01-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-2020-01-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: deprecated202001getblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-single.deprecated202001getblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/carrier-services/carrier-service-id-json name: admin-api-2020-01-carrier-services-carrier-service-id-json description: REST surface for admin-api-2020-01-carrier_services-carrier_service_id}.json. operations: - method: GET name: deprecated202001getcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-single.deprecated202001getcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/collections/collection-id-json name: admin-api-2020-01-collections-collection-id-json description: REST surface for admin-api-2020-01-collections-collection_id}.json. operations: - method: GET name: deprecated202001getcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-single.deprecated202001getcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/comments/comment-id-json name: admin-api-2020-01-comments-comment-id-json description: REST surface for admin-api-2020-01-comments-comment_id}.json. operations: - method: GET name: deprecated202001getcommentsparamcommentid description: Shopify Retrieves A Single Comment By Its Id call: shopify-single.deprecated202001getcommentsparamcommentid with: comment_id: rest.comment_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/countries/{country-id}/provinces/province-id-json name: admin-api-2020-01-countries-country-id-provinces-province-id-json description: REST surface for admin-api-2020-01-countries-country_id-provinces-province_id}.json. operations: - method: GET name: deprecated202001getcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-single.deprecated202001getcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/custom-collections/custom-collection-id-json name: admin-api-2020-01-custom-collections-custom-collection-id-json description: REST surface for admin-api-2020-01-custom_collections-custom_collection_id}.json. operations: - method: GET name: deprecated202001getcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-single.deprecated202001getcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customer-saved-searches/customer-saved-search-id-json name: admin-api-2020-01-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-2020-01-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: deprecated202001getcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-single.deprecated202001getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customers/customer-id-json name: admin-api-2020-01-customers-customer-id-json description: REST surface for admin-api-2020-01-customers-customer_id}.json. operations: - method: GET name: deprecated202001getcustomersparamcustomerid description: Shopify Retrieves A Single Customer call: shopify-single.deprecated202001getcustomersparamcustomerid with: customer_id: rest.customer_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/customers/{customer-id}/addresses/address-id-json name: admin-api-2020-01-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-2020-01-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: deprecated202001getcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-single.deprecated202001getcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/events/event-id-json name: admin-api-2020-01-events-event-id-json description: REST surface for admin-api-2020-01-events-event_id}.json. operations: - method: GET name: deprecated202001geteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-single.deprecated202001geteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/gift-cards/gift-card-id-json name: admin-api-2020-01-gift-cards-gift-card-id-json description: REST surface for admin-api-2020-01-gift_cards-gift_card_id}.json. operations: - method: GET name: deprecated202001getgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-single.deprecated202001getgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/inventory-items/inventory-item-id-json name: admin-api-2020-01-inventory-items-inventory-item-id-json description: REST surface for admin-api-2020-01-inventory_items-inventory_item_id}.json. operations: - method: GET name: deprecated202001getinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-single.deprecated202001getinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/inventory-levels/adjust-json name: admin-api-2020-01-inventory-levels-adjust-json description: REST surface for admin-api-2020-01-inventory_levels-adjust.json. operations: - method: POST name: deprecated202001createinventorylevelsadjust description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location call: shopify-single.deprecated202001createinventorylevelsadjust with: ? "inventory_item_id\n required" : "rest.inventory_item_id\n required" ? "location_id\n required" : "rest.location_id\n required" ? "available_adjustment\n required" : "rest.available_adjustment\n required" body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/locations/location-id-json name: admin-api-2020-01-locations-location-id-json description: REST surface for admin-api-2020-01-locations-location_id}.json. operations: - method: GET name: deprecated202001getlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-single.deprecated202001getlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/metafields/metafield-id-json name: admin-api-2020-01-metafields-metafield-id-json description: REST surface for admin-api-2020-01-metafields-metafield_id}.json. operations: - method: GET name: deprecated202001getmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-single.deprecated202001getmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/orders/{order-id}/risks/risk-id-json name: admin-api-2020-01-orders-order-id-risks-risk-id-json description: REST surface for admin-api-2020-01-orders-order_id-risks-risk_id}.json. operations: - method: GET name: deprecated202001getordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-single.deprecated202001getordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-2020-01-price-rules-price-rule-id-discount-codes-discount-code-id-jso description: REST surface for admin-api-2020-01-price_rules-price_rule_id-discount_codes-discount_code_id}.jso. operations: - method: GET name: deprecated202001getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-single.deprecated202001getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/products/product-id-json name: admin-api-2020-01-products-product-id-json description: REST surface for admin-api-2020-01-products-product_id}.json. operations: - method: GET name: deprecated202001getproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-single.deprecated202001getproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/products/{product-id}/images/image-id-json name: admin-api-2020-01-products-product-id-images-image-id-json description: REST surface for admin-api-2020-01-products-product_id-images-image_id}.json. operations: - method: GET name: deprecated202001getproductsparamproductidimagesparamimageid description: Shopify Get A Single Product Image By Id call: shopify-single.deprecated202001getproductsparamproductidimagesparamimageid with: product_id: rest.product_id image_id: rest.image_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/recurring-application-charges/recurring-application-charge-id-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: deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeid description: Shopify Retrieves A Single Charge call: shopify-single.deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: rest.recurring_application_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/recurring-application-charges/{recurring-application-charge-id}/usage-charges/usage-charge-id-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: deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid description: Shopify Retrieves A Single Charge call: shopify-single.deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: rest.recurring_application_charge_id usage_charge_id: rest.usage_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/redirects/redirect-id-json name: admin-api-2020-01-redirects-redirect-id-json description: REST surface for admin-api-2020-01-redirects-redirect_id}.json. operations: - method: GET name: deprecated202001getredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-single.deprecated202001getredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/reports/report-id-json name: admin-api-2020-01-reports-report-id-json description: REST surface for admin-api-2020-01-reports-report_id}.json. operations: - method: GET name: deprecated202001getreportsparamreportid description: Shopify Retrieves A Single Report Created By Your App call: shopify-single.deprecated202001getreportsparamreportid with: report_id: rest.report_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/script-tags/script-tag-id-json name: admin-api-2020-01-script-tags-script-tag-id-json description: REST surface for admin-api-2020-01-script_tags-script_tag_id}.json. operations: - method: GET name: deprecated202001getscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-single.deprecated202001getscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/shopify-payments/disputes/dispute-id-json name: admin-api-2020-01-shopify-payments-disputes-dispute-id-json description: REST surface for admin-api-2020-01-shopify_payments-disputes-dispute_id}.json. operations: - method: GET name: deprecated202001getshopifypaymentsdisputesparamdisputeid description: Shopify Retrieves A Single Dispute By Id call: shopify-single.deprecated202001getshopifypaymentsdisputesparamdisputeid with: dispute_id: rest.dispute_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/shopify-payments/payouts/payout-id-json name: admin-api-2020-01-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-2020-01-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: deprecated202001getshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-single.deprecated202001getshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/smart-collections/smart-collection-id-json name: admin-api-2020-01-smart-collections-smart-collection-id-json description: REST surface for admin-api-2020-01-smart_collections-smart_collection_id}.json. operations: - method: GET name: deprecated202001getsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-single.deprecated202001getsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/themes/theme-id-json name: admin-api-2020-01-themes-theme-id-json description: REST surface for admin-api-2020-01-themes-theme_id}.json. operations: - method: GET name: deprecated202001getthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-single.deprecated202001getthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/themes/{theme-id}/assets-json name: admin-api-2020-01-themes-theme-id-assets-json description: REST surface for admin-api-2020-01-themes-theme_id-assets.json. operations: - method: GET name: deprecated202001getthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-single.deprecated202001getthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/users/user-id-json name: admin-api-2020-01-users-user-id-json description: REST surface for admin-api-2020-01-users-user_id}.json. operations: - method: GET name: deprecated202001getusersparamuserid description: Shopify Retrieves A Single User call: shopify-single.deprecated202001getusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-01/webhooks/webhook-id-json name: admin-api-2020-01-webhooks-webhook-id-json description: REST surface for admin-api-2020-01-webhooks-webhook_id}.json. operations: - method: GET name: deprecated202001getwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-single.deprecated202001getwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/application-credits/application-credit-id-json name: admin-api-2020-04-application-credits-application-credit-id-json description: REST surface for admin-api-2020-04-application_credits-application_credit_id}.json. operations: - method: GET name: deprecated202004getapplicationcreditsparamapplicationcreditid description: Shopify Retrieves A Single Application Credit call: shopify-single.deprecated202004getapplicationcreditsparamapplicationcreditid with: application_credit_id: rest.application_credit_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/blogs/{blog-id}/articles/article-id-json name: admin-api-2020-04-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-2020-04-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: deprecated202004getblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-single.deprecated202004getblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/carrier-services/carrier-service-id-json name: admin-api-2020-04-carrier-services-carrier-service-id-json description: REST surface for admin-api-2020-04-carrier_services-carrier_service_id}.json. operations: - method: GET name: deprecated202004getcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-single.deprecated202004getcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/collections/collection-id-json name: admin-api-2020-04-collections-collection-id-json description: REST surface for admin-api-2020-04-collections-collection_id}.json. operations: - method: GET name: deprecated202004getcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-single.deprecated202004getcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/countries/{country-id}/provinces/province-id-json name: admin-api-2020-04-countries-country-id-provinces-province-id-json description: REST surface for admin-api-2020-04-countries-country_id-provinces-province_id}.json. operations: - method: GET name: deprecated202004getcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-single.deprecated202004getcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/custom-collections/custom-collection-id-json name: admin-api-2020-04-custom-collections-custom-collection-id-json description: REST surface for admin-api-2020-04-custom_collections-custom_collection_id}.json. operations: - method: GET name: deprecated202004getcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-single.deprecated202004getcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customer-saved-searches/customer-saved-search-id-json name: admin-api-2020-04-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-2020-04-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: deprecated202004getcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-single.deprecated202004getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customers/customer-id-json name: admin-api-2020-04-customers-customer-id-json description: REST surface for admin-api-2020-04-customers-customer_id}.json. operations: - method: GET name: deprecated202004getcustomersparamcustomerid description: Shopify Retrieves A Single Customer call: shopify-single.deprecated202004getcustomersparamcustomerid with: customer_id: rest.customer_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/customers/{customer-id}/addresses/address-id-json name: admin-api-2020-04-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-2020-04-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: deprecated202004getcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-single.deprecated202004getcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/events/event-id-json name: admin-api-2020-04-events-event-id-json description: REST surface for admin-api-2020-04-events-event_id}.json. operations: - method: GET name: deprecated202004geteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-single.deprecated202004geteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/gift-cards/gift-card-id-json name: admin-api-2020-04-gift-cards-gift-card-id-json description: REST surface for admin-api-2020-04-gift_cards-gift_card_id}.json. operations: - method: GET name: deprecated202004getgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-single.deprecated202004getgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/inventory-items/inventory-item-id-json name: admin-api-2020-04-inventory-items-inventory-item-id-json description: REST surface for admin-api-2020-04-inventory_items-inventory_item_id}.json. operations: - method: GET name: deprecated202004getinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-single.deprecated202004getinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/inventory-levels/adjust-json name: admin-api-2020-04-inventory-levels-adjust-json description: REST surface for admin-api-2020-04-inventory_levels-adjust.json. operations: - method: POST name: deprecated202004createinventorylevelsadjust description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location call: shopify-single.deprecated202004createinventorylevelsadjust with: ? "inventory_item_id\n required" : "rest.inventory_item_id\n required" ? "location_id\n required" : "rest.location_id\n required" ? "available_adjustment\n required" : "rest.available_adjustment\n required" body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/locations/location-id-json name: admin-api-2020-04-locations-location-id-json description: REST surface for admin-api-2020-04-locations-location_id}.json. operations: - method: GET name: deprecated202004getlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-single.deprecated202004getlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/metafields/metafield-id-json name: admin-api-2020-04-metafields-metafield-id-json description: REST surface for admin-api-2020-04-metafields-metafield_id}.json. operations: - method: GET name: deprecated202004getmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-single.deprecated202004getmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/orders/{order-id}/risks/risk-id-json name: admin-api-2020-04-orders-order-id-risks-risk-id-json description: REST surface for admin-api-2020-04-orders-order_id-risks-risk_id}.json. operations: - method: GET name: deprecated202004getordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-single.deprecated202004getordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-2020-04-price-rules-price-rule-id-discount-codes-discount-code-id-jso description: REST surface for admin-api-2020-04-price_rules-price_rule_id-discount_codes-discount_code_id}.jso. operations: - method: GET name: deprecated202004getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-single.deprecated202004getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/products/product-id-json name: admin-api-2020-04-products-product-id-json description: REST surface for admin-api-2020-04-products-product_id}.json. operations: - method: GET name: deprecated202004getproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-single.deprecated202004getproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/products/{product-id}/images/image-id-json name: admin-api-2020-04-products-product-id-images-image-id-json description: REST surface for admin-api-2020-04-products-product_id-images-image_id}.json. operations: - method: GET name: deprecated202004getproductsparamproductidimagesparamimageid description: Shopify Get A Single Product Image By Id call: shopify-single.deprecated202004getproductsparamproductidimagesparamimageid with: product_id: rest.product_id image_id: rest.image_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/recurring-application-charges/recurring-application-charge-id-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: deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeid description: Shopify Retrieves A Single Charge call: shopify-single.deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: rest.recurring_application_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/recurring-application-charges/{recurring-application-charge-id}/usage-charges/usage-charge-id-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: deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid description: Shopify Retrieves A Single Charge call: shopify-single.deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: rest.recurring_application_charge_id usage_charge_id: rest.usage_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/redirects/redirect-id-json name: admin-api-2020-04-redirects-redirect-id-json description: REST surface for admin-api-2020-04-redirects-redirect_id}.json. operations: - method: GET name: deprecated202004getredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-single.deprecated202004getredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/reports/report-id-json name: admin-api-2020-04-reports-report-id-json description: REST surface for admin-api-2020-04-reports-report_id}.json. operations: - method: GET name: deprecated202004getreportsparamreportid description: Shopify Retrieves A Single Report Created By Your App call: shopify-single.deprecated202004getreportsparamreportid with: report_id: rest.report_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/script-tags/script-tag-id-json name: admin-api-2020-04-script-tags-script-tag-id-json description: REST surface for admin-api-2020-04-script_tags-script_tag_id}.json. operations: - method: GET name: deprecated202004getscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-single.deprecated202004getscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/shopify-payments/payouts/payout-id-json name: admin-api-2020-04-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-2020-04-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: deprecated202004getshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-single.deprecated202004getshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/smart-collections/smart-collection-id-json name: admin-api-2020-04-smart-collections-smart-collection-id-json description: REST surface for admin-api-2020-04-smart_collections-smart_collection_id}.json. operations: - method: GET name: deprecated202004getsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-single.deprecated202004getsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/themes/theme-id-json name: admin-api-2020-04-themes-theme-id-json description: REST surface for admin-api-2020-04-themes-theme_id}.json. operations: - method: GET name: deprecated202004getthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-single.deprecated202004getthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/themes/{theme-id}/assets-json name: admin-api-2020-04-themes-theme-id-assets-json description: REST surface for admin-api-2020-04-themes-theme_id-assets.json. operations: - method: GET name: deprecated202004getthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-single.deprecated202004getthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/users/user-id-json name: admin-api-2020-04-users-user-id-json description: REST surface for admin-api-2020-04-users-user_id}.json. operations: - method: GET name: deprecated202004getusersparamuserid description: Shopify Retrieves A Single User call: shopify-single.deprecated202004getusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-04/webhooks/webhook-id-json name: admin-api-2020-04-webhooks-webhook-id-json description: REST surface for admin-api-2020-04-webhooks-webhook_id}.json. operations: - method: GET name: deprecated202004getwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-single.deprecated202004getwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/application-credits/application-credit-id-json name: admin-api-2020-07-application-credits-application-credit-id-json description: REST surface for admin-api-2020-07-application_credits-application_credit_id}.json. operations: - method: GET name: deprecated202007getapplicationcreditsparamapplicationcreditid description: Shopify Retrieves A Single Application Credit call: shopify-single.deprecated202007getapplicationcreditsparamapplicationcreditid with: application_credit_id: rest.application_credit_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/blogs/{blog-id}/articles/article-id-json name: admin-api-2020-07-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-2020-07-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: deprecated202007getblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-single.deprecated202007getblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/carrier-services/carrier-service-id-json name: admin-api-2020-07-carrier-services-carrier-service-id-json description: REST surface for admin-api-2020-07-carrier_services-carrier_service_id}.json. operations: - method: GET name: deprecated202007getcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-single.deprecated202007getcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/collections/collection-id-json name: admin-api-2020-07-collections-collection-id-json description: REST surface for admin-api-2020-07-collections-collection_id}.json. operations: - method: GET name: deprecated202007getcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-single.deprecated202007getcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/countries/{country-id}/provinces/province-id-json name: admin-api-2020-07-countries-country-id-provinces-province-id-json description: REST surface for admin-api-2020-07-countries-country_id-provinces-province_id}.json. operations: - method: GET name: deprecated202007getcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-single.deprecated202007getcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/custom-collections/custom-collection-id-json name: admin-api-2020-07-custom-collections-custom-collection-id-json description: REST surface for admin-api-2020-07-custom_collections-custom_collection_id}.json. operations: - method: GET name: deprecated202007getcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-single.deprecated202007getcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customer-saved-searches/customer-saved-search-id-json name: admin-api-2020-07-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-2020-07-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: deprecated202007getcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-single.deprecated202007getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customers/customer-id-json name: admin-api-2020-07-customers-customer-id-json description: REST surface for admin-api-2020-07-customers-customer_id}.json. operations: - method: GET name: deprecated202007getcustomersparamcustomerid description: Shopify Retrieves A Single Customer call: shopify-single.deprecated202007getcustomersparamcustomerid with: customer_id: rest.customer_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/customers/{customer-id}/addresses/address-id-json name: admin-api-2020-07-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-2020-07-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: deprecated202007getcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-single.deprecated202007getcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/events/event-id-json name: admin-api-2020-07-events-event-id-json description: REST surface for admin-api-2020-07-events-event_id}.json. operations: - method: GET name: deprecated202007geteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-single.deprecated202007geteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/gift-cards/gift-card-id-json name: admin-api-2020-07-gift-cards-gift-card-id-json description: REST surface for admin-api-2020-07-gift_cards-gift_card_id}.json. operations: - method: GET name: deprecated202007getgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-single.deprecated202007getgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/inventory-items/inventory-item-id-json name: admin-api-2020-07-inventory-items-inventory-item-id-json description: REST surface for admin-api-2020-07-inventory_items-inventory_item_id}.json. operations: - method: GET name: deprecated202007getinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-single.deprecated202007getinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/inventory-levels/adjust-json name: admin-api-2020-07-inventory-levels-adjust-json description: REST surface for admin-api-2020-07-inventory_levels-adjust.json. operations: - method: POST name: deprecated202007createinventorylevelsadjust description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location call: shopify-single.deprecated202007createinventorylevelsadjust with: ? "inventory_item_id\n required" : "rest.inventory_item_id\n required" ? "location_id\n required" : "rest.location_id\n required" ? "available_adjustment\n required" : "rest.available_adjustment\n required" body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/locations/location-id-json name: admin-api-2020-07-locations-location-id-json description: REST surface for admin-api-2020-07-locations-location_id}.json. operations: - method: GET name: deprecated202007getlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-single.deprecated202007getlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/metafields/metafield-id-json name: admin-api-2020-07-metafields-metafield-id-json description: REST surface for admin-api-2020-07-metafields-metafield_id}.json. operations: - method: GET name: deprecated202007getmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-single.deprecated202007getmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/orders/{order-id}/risks/risk-id-json name: admin-api-2020-07-orders-order-id-risks-risk-id-json description: REST surface for admin-api-2020-07-orders-order_id-risks-risk_id}.json. operations: - method: GET name: deprecated202007getordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-single.deprecated202007getordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-2020-07-price-rules-price-rule-id-discount-codes-discount-code-id-jso description: REST surface for admin-api-2020-07-price_rules-price_rule_id-discount_codes-discount_code_id}.jso. operations: - method: GET name: deprecated202007getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-single.deprecated202007getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/products/product-id-json name: admin-api-2020-07-products-product-id-json description: REST surface for admin-api-2020-07-products-product_id}.json. operations: - method: GET name: deprecated202007getproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-single.deprecated202007getproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/products/{product-id}/images/image-id-json name: admin-api-2020-07-products-product-id-images-image-id-json description: REST surface for admin-api-2020-07-products-product_id-images-image_id}.json. operations: - method: GET name: deprecated202007getproductsparamproductidimagesparamimageid description: Shopify Get A Single Product Image By Id call: shopify-single.deprecated202007getproductsparamproductidimagesparamimageid with: product_id: rest.product_id image_id: rest.image_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/recurring-application-charges/recurring-application-charge-id-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: deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeid description: Shopify Retrieves A Single Charge call: shopify-single.deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: rest.recurring_application_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/recurring-application-charges/{recurring-application-charge-id}/usage-charges/usage-charge-id-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: deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid description: Shopify Retrieves A Single Charge call: shopify-single.deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: rest.recurring_application_charge_id usage_charge_id: rest.usage_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/redirects/redirect-id-json name: admin-api-2020-07-redirects-redirect-id-json description: REST surface for admin-api-2020-07-redirects-redirect_id}.json. operations: - method: GET name: deprecated202007getredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-single.deprecated202007getredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/reports/report-id-json name: admin-api-2020-07-reports-report-id-json description: REST surface for admin-api-2020-07-reports-report_id}.json. operations: - method: GET name: deprecated202007getreportsparamreportid description: Shopify Retrieves A Single Report Created By Your App call: shopify-single.deprecated202007getreportsparamreportid with: report_id: rest.report_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/script-tags/script-tag-id-json name: admin-api-2020-07-script-tags-script-tag-id-json description: REST surface for admin-api-2020-07-script_tags-script_tag_id}.json. operations: - method: GET name: deprecated202007getscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-single.deprecated202007getscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/shopify-payments/payouts/payout-id-json name: admin-api-2020-07-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-2020-07-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: deprecated202007getshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-single.deprecated202007getshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/smart-collections/smart-collection-id-json name: admin-api-2020-07-smart-collections-smart-collection-id-json description: REST surface for admin-api-2020-07-smart_collections-smart_collection_id}.json. operations: - method: GET name: deprecated202007getsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-single.deprecated202007getsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/themes/theme-id-json name: admin-api-2020-07-themes-theme-id-json description: REST surface for admin-api-2020-07-themes-theme_id}.json. operations: - method: GET name: deprecated202007getthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-single.deprecated202007getthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/themes/{theme-id}/assets-json name: admin-api-2020-07-themes-theme-id-assets-json description: REST surface for admin-api-2020-07-themes-theme_id-assets.json. operations: - method: GET name: deprecated202007getthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-single.deprecated202007getthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/users/user-id-json name: admin-api-2020-07-users-user-id-json description: REST surface for admin-api-2020-07-users-user_id}.json. operations: - method: GET name: deprecated202007getusersparamuserid description: Shopify Retrieves A Single User call: shopify-single.deprecated202007getusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-07/webhooks/webhook-id-json name: admin-api-2020-07-webhooks-webhook-id-json description: REST surface for admin-api-2020-07-webhooks-webhook_id}.json. operations: - method: GET name: deprecated202007getwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-single.deprecated202007getwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/application-credits/application-credit-id-json name: admin-api-2020-10-application-credits-application-credit-id-json description: REST surface for admin-api-2020-10-application_credits-application_credit_id}.json. operations: - method: GET name: getapplicationcreditsparamapplicationcreditid description: Shopify Retrieves A Single Application Credit call: shopify-single.getapplicationcreditsparamapplicationcreditid with: application_credit_id: rest.application_credit_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/blogs/{blog-id}/articles/article-id-json name: admin-api-2020-10-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-2020-10-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: getblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-single.getblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/carrier-services/carrier-service-id-json name: admin-api-2020-10-carrier-services-carrier-service-id-json description: REST surface for admin-api-2020-10-carrier_services-carrier_service_id}.json. operations: - method: GET name: getcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-single.getcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/collections/collection-id-json name: admin-api-2020-10-collections-collection-id-json description: REST surface for admin-api-2020-10-collections-collection_id}.json. operations: - method: GET name: getcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-single.getcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/countries/{country-id}/provinces/province-id-json name: admin-api-2020-10-countries-country-id-provinces-province-id-json description: REST surface for admin-api-2020-10-countries-country_id-provinces-province_id}.json. operations: - method: GET name: getcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-single.getcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/custom-collections/custom-collection-id-json name: admin-api-2020-10-custom-collections-custom-collection-id-json description: REST surface for admin-api-2020-10-custom_collections-custom_collection_id}.json. operations: - method: GET name: getcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-single.getcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customer-saved-searches/customer-saved-search-id-json name: admin-api-2020-10-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-2020-10-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: getcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-single.getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customers/customer-id-json name: admin-api-2020-10-customers-customer-id-json description: REST surface for admin-api-2020-10-customers-customer_id}.json. operations: - method: GET name: getcustomersparamcustomerid description: Shopify Retrieves A Single Customer call: shopify-single.getcustomersparamcustomerid with: customer_id: rest.customer_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/customers/{customer-id}/addresses/address-id-json name: admin-api-2020-10-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-2020-10-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: getcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-single.getcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/events/event-id-json name: admin-api-2020-10-events-event-id-json description: REST surface for admin-api-2020-10-events-event_id}.json. operations: - method: GET name: geteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-single.geteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/gift-cards/gift-card-id-json name: admin-api-2020-10-gift-cards-gift-card-id-json description: REST surface for admin-api-2020-10-gift_cards-gift_card_id}.json. operations: - method: GET name: getgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-single.getgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/inventory-items/inventory-item-id-json name: admin-api-2020-10-inventory-items-inventory-item-id-json description: REST surface for admin-api-2020-10-inventory_items-inventory_item_id}.json. operations: - method: GET name: getinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-single.getinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/inventory-levels/adjust-json name: admin-api-2020-10-inventory-levels-adjust-json description: REST surface for admin-api-2020-10-inventory_levels-adjust.json. operations: - method: POST name: createinventorylevelsadjust description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location call: shopify-single.createinventorylevelsadjust with: ? "inventory_item_id\n required" : "rest.inventory_item_id\n required" ? "location_id\n required" : "rest.location_id\n required" ? "available_adjustment\n required" : "rest.available_adjustment\n required" body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/locations/location-id-json name: admin-api-2020-10-locations-location-id-json description: REST surface for admin-api-2020-10-locations-location_id}.json. operations: - method: GET name: getlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-single.getlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/metafields/metafield-id-json name: admin-api-2020-10-metafields-metafield-id-json description: REST surface for admin-api-2020-10-metafields-metafield_id}.json. operations: - method: GET name: getmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-single.getmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/orders/{order-id}/risks/risk-id-json name: admin-api-2020-10-orders-order-id-risks-risk-id-json description: REST surface for admin-api-2020-10-orders-order_id-risks-risk_id}.json. operations: - method: GET name: getordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-single.getordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-2020-10-price-rules-price-rule-id-discount-codes-discount-code-id-jso description: REST surface for admin-api-2020-10-price_rules-price_rule_id-discount_codes-discount_code_id}.jso. operations: - method: GET name: getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-single.getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/products/product-id-json name: admin-api-2020-10-products-product-id-json description: REST surface for admin-api-2020-10-products-product_id}.json. operations: - method: GET name: getproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-single.getproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/products/{product-id}/images/image-id-json name: admin-api-2020-10-products-product-id-images-image-id-json description: REST surface for admin-api-2020-10-products-product_id-images-image_id}.json. operations: - method: GET name: getproductsparamproductidimagesparamimageid description: Shopify Get A Single Product Image By Id call: shopify-single.getproductsparamproductidimagesparamimageid with: product_id: rest.product_id image_id: rest.image_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/recurring-application-charges/recurring-application-charge-id-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: getrecurringapplicationchargesparamrecurringapplicationchargeid description: Shopify Retrieves A Single Charge call: shopify-single.getrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: rest.recurring_application_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/recurring-application-charges/{recurring-application-charge-id}/usage-charges/usage-charge-id-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: getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid description: Shopify Retrieves A Single Charge call: shopify-single.getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: rest.recurring_application_charge_id usage_charge_id: rest.usage_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/redirects/redirect-id-json name: admin-api-2020-10-redirects-redirect-id-json description: REST surface for admin-api-2020-10-redirects-redirect_id}.json. operations: - method: GET name: getredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-single.getredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/reports/report-id-json name: admin-api-2020-10-reports-report-id-json description: REST surface for admin-api-2020-10-reports-report_id}.json. operations: - method: GET name: getreportsparamreportid description: Shopify Retrieves A Single Report Created By Your App call: shopify-single.getreportsparamreportid with: report_id: rest.report_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/script-tags/script-tag-id-json name: admin-api-2020-10-script-tags-script-tag-id-json description: REST surface for admin-api-2020-10-script_tags-script_tag_id}.json. operations: - method: GET name: getscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-single.getscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/shopify-payments/payouts/payout-id-json name: admin-api-2020-10-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-2020-10-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: getshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-single.getshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/smart-collections/smart-collection-id-json name: admin-api-2020-10-smart-collections-smart-collection-id-json description: REST surface for admin-api-2020-10-smart_collections-smart_collection_id}.json. operations: - method: GET name: getsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-single.getsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/themes/theme-id-json name: admin-api-2020-10-themes-theme-id-json description: REST surface for admin-api-2020-10-themes-theme_id}.json. operations: - method: GET name: getthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-single.getthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/themes/{theme-id}/assets-json name: admin-api-2020-10-themes-theme-id-assets-json description: REST surface for admin-api-2020-10-themes-theme_id-assets.json. operations: - method: GET name: getthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-single.getthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/users/user-id-json name: admin-api-2020-10-users-user-id-json description: REST surface for admin-api-2020-10-users-user_id}.json. operations: - method: GET name: getusersparamuserid description: Shopify Retrieves A Single User call: shopify-single.getusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2020-10/webhooks/webhook-id-json name: admin-api-2020-10-webhooks-webhook-id-json description: REST surface for admin-api-2020-10-webhooks-webhook_id}.json. operations: - method: GET name: getwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-single.getwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/application-credits/application-credit-id-json name: admin-api-2021-01-application-credits-application-credit-id-json description: REST surface for admin-api-2021-01-application_credits-application_credit_id}.json. operations: - method: GET name: deprecated202101getapplicationcreditsparamapplicationcreditid description: Shopify Retrieves A Single Application Credit call: shopify-single.deprecated202101getapplicationcreditsparamapplicationcreditid with: application_credit_id: rest.application_credit_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/blogs/{blog-id}/articles/article-id-json name: admin-api-2021-01-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-2021-01-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: deprecated202101getblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-single.deprecated202101getblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/carrier-services/carrier-service-id-json name: admin-api-2021-01-carrier-services-carrier-service-id-json description: REST surface for admin-api-2021-01-carrier_services-carrier_service_id}.json. operations: - method: GET name: deprecated202101getcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-single.deprecated202101getcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/collections/collection-id-json name: admin-api-2021-01-collections-collection-id-json description: REST surface for admin-api-2021-01-collections-collection_id}.json. operations: - method: GET name: deprecated202101getcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-single.deprecated202101getcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/countries/{country-id}/provinces/province-id-json name: admin-api-2021-01-countries-country-id-provinces-province-id-json description: REST surface for admin-api-2021-01-countries-country_id-provinces-province_id}.json. operations: - method: GET name: deprecated202101getcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-single.deprecated202101getcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/custom-collections/custom-collection-id-json name: admin-api-2021-01-custom-collections-custom-collection-id-json description: REST surface for admin-api-2021-01-custom_collections-custom_collection_id}.json. operations: - method: GET name: deprecated202101getcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-single.deprecated202101getcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customer-saved-searches/customer-saved-search-id-json name: admin-api-2021-01-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-2021-01-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: deprecated202101getcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-single.deprecated202101getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customers/customer-id-json name: admin-api-2021-01-customers-customer-id-json description: REST surface for admin-api-2021-01-customers-customer_id}.json. operations: - method: GET name: deprecated202101getcustomersparamcustomerid description: Shopify Retrieves A Single Customer call: shopify-single.deprecated202101getcustomersparamcustomerid with: customer_id: rest.customer_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/customers/{customer-id}/addresses/address-id-json name: admin-api-2021-01-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-2021-01-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: deprecated202101getcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-single.deprecated202101getcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/events/event-id-json name: admin-api-2021-01-events-event-id-json description: REST surface for admin-api-2021-01-events-event_id}.json. operations: - method: GET name: deprecated202101geteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-single.deprecated202101geteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/gift-cards/gift-card-id-json name: admin-api-2021-01-gift-cards-gift-card-id-json description: REST surface for admin-api-2021-01-gift_cards-gift_card_id}.json. operations: - method: GET name: deprecated202101getgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-single.deprecated202101getgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/inventory-items/inventory-item-id-json name: admin-api-2021-01-inventory-items-inventory-item-id-json description: REST surface for admin-api-2021-01-inventory_items-inventory_item_id}.json. operations: - method: GET name: deprecated202101getinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-single.deprecated202101getinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/inventory-levels/adjust-json name: admin-api-2021-01-inventory-levels-adjust-json description: REST surface for admin-api-2021-01-inventory_levels-adjust.json. operations: - method: POST name: deprecated202101createinventorylevelsadjust description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location call: shopify-single.deprecated202101createinventorylevelsadjust with: ? "inventory_item_id\n required" : "rest.inventory_item_id\n required" ? "location_id\n required" : "rest.location_id\n required" ? "available_adjustment\n required" : "rest.available_adjustment\n required" body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/locations/location-id-json name: admin-api-2021-01-locations-location-id-json description: REST surface for admin-api-2021-01-locations-location_id}.json. operations: - method: GET name: deprecated202101getlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-single.deprecated202101getlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/metafields/metafield-id-json name: admin-api-2021-01-metafields-metafield-id-json description: REST surface for admin-api-2021-01-metafields-metafield_id}.json. operations: - method: GET name: deprecated202101getmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-single.deprecated202101getmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/orders/{order-id}/risks/risk-id-json name: admin-api-2021-01-orders-order-id-risks-risk-id-json description: REST surface for admin-api-2021-01-orders-order_id-risks-risk_id}.json. operations: - method: GET name: deprecated202101getordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-single.deprecated202101getordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-2021-01-price-rules-price-rule-id-discount-codes-discount-code-id-jso description: REST surface for admin-api-2021-01-price_rules-price_rule_id-discount_codes-discount_code_id}.jso. operations: - method: GET name: deprecated202101getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-single.deprecated202101getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/products/product-id-json name: admin-api-2021-01-products-product-id-json description: REST surface for admin-api-2021-01-products-product_id}.json. operations: - method: GET name: deprecated202101getproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-single.deprecated202101getproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/products/{product-id}/images/image-id-json name: admin-api-2021-01-products-product-id-images-image-id-json description: REST surface for admin-api-2021-01-products-product_id-images-image_id}.json. operations: - method: GET name: deprecated202101getproductsparamproductidimagesparamimageid description: Shopify Get A Single Product Image By Id call: shopify-single.deprecated202101getproductsparamproductidimagesparamimageid with: product_id: rest.product_id image_id: rest.image_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/recurring-application-charges/recurring-application-charge-id-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: deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeid description: Shopify Retrieves A Single Charge call: shopify-single.deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: rest.recurring_application_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/recurring-application-charges/{recurring-application-charge-id}/usage-charges/usage-charge-id-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: deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid description: Shopify Retrieves A Single Charge call: shopify-single.deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: rest.recurring_application_charge_id usage_charge_id: rest.usage_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/redirects/redirect-id-json name: admin-api-2021-01-redirects-redirect-id-json description: REST surface for admin-api-2021-01-redirects-redirect_id}.json. operations: - method: GET name: deprecated202101getredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-single.deprecated202101getredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/reports/report-id-json name: admin-api-2021-01-reports-report-id-json description: REST surface for admin-api-2021-01-reports-report_id}.json. operations: - method: GET name: deprecated202101getreportsparamreportid description: Shopify Retrieves A Single Report Created By Your App call: shopify-single.deprecated202101getreportsparamreportid with: report_id: rest.report_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/script-tags/script-tag-id-json name: admin-api-2021-01-script-tags-script-tag-id-json description: REST surface for admin-api-2021-01-script_tags-script_tag_id}.json. operations: - method: GET name: deprecated202101getscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-single.deprecated202101getscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/shopify-payments/payouts/payout-id-json name: admin-api-2021-01-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-2021-01-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: deprecated202101getshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-single.deprecated202101getshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/smart-collections/smart-collection-id-json name: admin-api-2021-01-smart-collections-smart-collection-id-json description: REST surface for admin-api-2021-01-smart_collections-smart_collection_id}.json. operations: - method: GET name: deprecated202101getsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-single.deprecated202101getsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/themes/theme-id-json name: admin-api-2021-01-themes-theme-id-json description: REST surface for admin-api-2021-01-themes-theme_id}.json. operations: - method: GET name: deprecated202101getthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-single.deprecated202101getthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/themes/{theme-id}/assets-json name: admin-api-2021-01-themes-theme-id-assets-json description: REST surface for admin-api-2021-01-themes-theme_id-assets.json. operations: - method: GET name: deprecated202101getthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-single.deprecated202101getthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/users/user-id-json name: admin-api-2021-01-users-user-id-json description: REST surface for admin-api-2021-01-users-user_id}.json. operations: - method: GET name: deprecated202101getusersparamuserid description: Shopify Retrieves A Single User call: shopify-single.deprecated202101getusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/2021-01/webhooks/webhook-id-json name: admin-api-2021-01-webhooks-webhook-id-json description: REST surface for admin-api-2021-01-webhooks-webhook_id}.json. operations: - method: GET name: deprecated202101getwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-single.deprecated202101getwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/application-credits/application-credit-id-json name: admin-api-unstable-application-credits-application-credit-id-json description: REST surface for admin-api-unstable-application_credits-application_credit_id}.json. operations: - method: GET name: deprecatedunstablegetapplicationcreditsparamapplicationcreditid description: Shopify Retrieves A Single Application Credit call: shopify-single.deprecatedunstablegetapplicationcreditsparamapplicationcreditid with: application_credit_id: rest.application_credit_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/blogs/{blog-id}/articles/article-id-json name: admin-api-unstable-blogs-blog-id-articles-article-id-json description: REST surface for admin-api-unstable-blogs-blog_id-articles-article_id}.json. operations: - method: GET name: deprecatedunstablegetblogsparamblogidarticlesparamarticleid description: Shopify Retrieves A Single Article call: shopify-single.deprecatedunstablegetblogsparamblogidarticlesparamarticleid with: blog_id: rest.blog_id article_id: rest.article_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/carrier-services/carrier-service-id-json name: admin-api-unstable-carrier-services-carrier-service-id-json description: REST surface for admin-api-unstable-carrier_services-carrier_service_id}.json. operations: - method: GET name: deprecatedunstablegetcarrierservicesparamcarrierserviceid description: Shopify Retrieves A Single Carrier Service By Its Id call: shopify-single.deprecatedunstablegetcarrierservicesparamcarrierserviceid with: carrier_service_id: rest.carrier_service_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/collections/collection-id-json name: admin-api-unstable-collections-collection-id-json description: REST surface for admin-api-unstable-collections-collection_id}.json. operations: - method: GET name: deprecatedunstablegetcollectionsparamcollectionid description: Shopify Retrieves A Single Collection call: shopify-single.deprecatedunstablegetcollectionsparamcollectionid with: collection_id: rest.collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/countries/{country-id}/provinces/province-id-json name: admin-api-unstable-countries-country-id-provinces-province-id-json description: REST surface for admin-api-unstable-countries-country_id-provinces-province_id}.json. operations: - method: GET name: deprecatedunstablegetcountriesparamcountryidprovincesparamprovinceid description: Shopify Retrieves A Single Province For A Country call: shopify-single.deprecatedunstablegetcountriesparamcountryidprovincesparamprovinceid with: country_id: rest.country_id province_id: rest.province_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/custom-collections/custom-collection-id-json name: admin-api-unstable-custom-collections-custom-collection-id-json description: REST surface for admin-api-unstable-custom_collections-custom_collection_id}.json. operations: - method: GET name: deprecatedunstablegetcustomcollectionsparamcustomcollectionid description: Shopify Retrieves A Single Custom Collection call: shopify-single.deprecatedunstablegetcustomcollectionsparamcustomcollectionid with: custom_collection_id: rest.custom_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customer-saved-searches/customer-saved-search-id-json name: admin-api-unstable-customer-saved-searches-customer-saved-search-id-json description: REST surface for admin-api-unstable-customer_saved_searches-customer_saved_search_id}.json. operations: - method: GET name: deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchid description: Shopify Retrieves A Single Customer Saved Search call: shopify-single.deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: rest.customer_saved_search_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customers/customer-id-json name: admin-api-unstable-customers-customer-id-json description: REST surface for admin-api-unstable-customers-customer_id}.json. operations: - method: GET name: deprecatedunstablegetcustomersparamcustomerid description: Shopify Retrieves A Single Customer call: shopify-single.deprecatedunstablegetcustomersparamcustomerid with: customer_id: rest.customer_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/customers/{customer-id}/addresses/address-id-json name: admin-api-unstable-customers-customer-id-addresses-address-id-json description: REST surface for admin-api-unstable-customers-customer_id-addresses-address_id}.json. operations: - method: GET name: deprecatedunstablegetcustomersparamcustomeridaddressesparamaddressid description: Shopify Retrieves Details A Single Customer Address call: shopify-single.deprecatedunstablegetcustomersparamcustomeridaddressesparamaddressid with: customer_id: rest.customer_id address_id: rest.address_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/events/event-id-json name: admin-api-unstable-events-event-id-json description: REST surface for admin-api-unstable-events-event_id}.json. operations: - method: GET name: deprecatedunstablegeteventsparameventid description: Shopify Retrieves A Single Event By Its Id call: shopify-single.deprecatedunstablegeteventsparameventid with: event_id: rest.event_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/gift-cards/gift-card-id-json name: admin-api-unstable-gift-cards-gift-card-id-json description: REST surface for admin-api-unstable-gift_cards-gift_card_id}.json. operations: - method: GET name: deprecatedunstablegetgiftcardsparamgiftcardid description: Shopify Retrieves A Single Gift Card By Its Id call: shopify-single.deprecatedunstablegetgiftcardsparamgiftcardid with: gift_card_id: rest.gift_card_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/inventory-items/inventory-item-id-json name: admin-api-unstable-inventory-items-inventory-item-id-json description: REST surface for admin-api-unstable-inventory_items-inventory_item_id}.json. operations: - method: GET name: deprecatedunstablegetinventoryitemsparaminventoryitemid description: Shopify Retrieves A Single Inventory Item By Id call: shopify-single.deprecatedunstablegetinventoryitemsparaminventoryitemid with: inventory_item_id: rest.inventory_item_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/inventory-levels/adjust-json name: admin-api-unstable-inventory-levels-adjust-json description: REST surface for admin-api-unstable-inventory_levels-adjust.json. operations: - method: POST name: deprecatedunstablecreateinventorylevelsadjust description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location call: shopify-single.deprecatedunstablecreateinventorylevelsadjust with: ? "inventory_item_id\n required" : "rest.inventory_item_id\n required" ? "location_id\n required" : "rest.location_id\n required" ? "available_adjustment\n required" : "rest.available_adjustment\n required" body: rest.body outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/locations/location-id-json name: admin-api-unstable-locations-location-id-json description: REST surface for admin-api-unstable-locations-location_id}.json. operations: - method: GET name: deprecatedunstablegetlocationsparamlocationid description: Shopify Retrieves A Single Location By Its Id call: shopify-single.deprecatedunstablegetlocationsparamlocationid with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/metafields/metafield-id-json name: admin-api-unstable-metafields-metafield-id-json description: REST surface for admin-api-unstable-metafields-metafield_id}.json. operations: - method: GET name: deprecatedunstablegetmetafieldsparammetafieldid description: Shopify Retrieves A Single Metafield From A Resource By Its Id call: shopify-single.deprecatedunstablegetmetafieldsparammetafieldid with: metafield_id: rest.metafield_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/orders/{order-id}/risks/risk-id-json name: admin-api-unstable-orders-order-id-risks-risk-id-json description: REST surface for admin-api-unstable-orders-order_id-risks-risk_id}.json. operations: - method: GET name: deprecatedunstablegetordersparamorderidrisksparamriskid description: Shopify Retrieves A Single Order Risk By Its Id call: shopify-single.deprecatedunstablegetordersparamorderidrisksparamriskid with: order_id: rest.order_id risk_id: rest.risk_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/price-rules/{price-rule-id}/discount-codes/discount-code-id-json name: admin-api-unstable-price-rules-price-rule-id-discount-codes-discount-code-id-js description: REST surface for admin-api-unstable-price_rules-price_rule_id-discount_codes-discount_code_id}.js. operations: - method: GET name: deprecatedunstablegetpricerulesparampriceruleiddiscountcodesparamdiscountcodeid description: Shopify Retrieves A Single Discount Code call: shopify-single.deprecatedunstablegetpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: rest.price_rule_id discount_code_id: rest.discount_code_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/products/product-id-json name: admin-api-unstable-products-product-id-json description: REST surface for admin-api-unstable-products-product_id}.json. operations: - method: GET name: deprecatedunstablegetproductsparamproductid description: Shopify Retrieves A Single Product call: shopify-single.deprecatedunstablegetproductsparamproductid with: product_id: rest.product_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/products/{product-id}/images/image-id-json name: admin-api-unstable-products-product-id-images-image-id-json description: REST surface for admin-api-unstable-products-product_id-images-image_id}.json. operations: - method: GET name: deprecatedunstablegetproductsparamproductidimagesparamimageid description: Shopify Get A Single Product Image By Id call: shopify-single.deprecatedunstablegetproductsparamproductidimagesparamimageid with: product_id: rest.product_id image_id: rest.image_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/recurring-application-charges/recurring-application-charge-id-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: deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeid description: Shopify Retrieves A Single Charge call: shopify-single.deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: rest.recurring_application_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/recurring-application-charges/{recurring-application-charge-id}/usage-charges/usage-charge-id-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: deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid description: Shopify Retrieves A Single Charge call: shopify-single.deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: rest.recurring_application_charge_id usage_charge_id: rest.usage_charge_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/redirects/redirect-id-json name: admin-api-unstable-redirects-redirect-id-json description: REST surface for admin-api-unstable-redirects-redirect_id}.json. operations: - method: GET name: deprecatedunstablegetredirectsparamredirectid description: Shopify Retrieves A Single Redirect call: shopify-single.deprecatedunstablegetredirectsparamredirectid with: redirect_id: rest.redirect_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/reports/report-id-json name: admin-api-unstable-reports-report-id-json description: REST surface for admin-api-unstable-reports-report_id}.json. operations: - method: GET name: deprecatedunstablegetreportsparamreportid description: Shopify Retrieves A Single Report Created By Your App call: shopify-single.deprecatedunstablegetreportsparamreportid with: report_id: rest.report_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/script-tags/script-tag-id-json name: admin-api-unstable-script-tags-script-tag-id-json description: REST surface for admin-api-unstable-script_tags-script_tag_id}.json. operations: - method: GET name: deprecatedunstablegetscripttagsparamscripttagid description: Shopify Retrieves A Single Script Tag call: shopify-single.deprecatedunstablegetscripttagsparamscripttagid with: script_tag_id: rest.script_tag_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/shopify-payments/payouts/payout-id-json name: admin-api-unstable-shopify-payments-payouts-payout-id-json description: REST surface for admin-api-unstable-shopify_payments-payouts-payout_id}.json. operations: - method: GET name: deprecatedunstablegetshopifypaymentspayoutsparampayoutid description: Shopify Retrieves A Single Payout By Id call: shopify-single.deprecatedunstablegetshopifypaymentspayoutsparampayoutid with: payout_id: rest.payout_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/smart-collections/smart-collection-id-json name: admin-api-unstable-smart-collections-smart-collection-id-json description: REST surface for admin-api-unstable-smart_collections-smart_collection_id}.json. operations: - method: GET name: deprecatedunstablegetsmartcollectionsparamsmartcollectionid description: Shopify Retrieves A Single Smart Collection call: shopify-single.deprecatedunstablegetsmartcollectionsparamsmartcollectionid with: smart_collection_id: rest.smart_collection_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/themes/theme-id-json name: admin-api-unstable-themes-theme-id-json description: REST surface for admin-api-unstable-themes-theme_id}.json. operations: - method: GET name: deprecatedunstablegetthemesparamthemeid description: Shopify Retrieves A Single Theme call: shopify-single.deprecatedunstablegetthemesparamthemeid with: theme_id: rest.theme_id fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/themes/{theme-id}/assets-json name: admin-api-unstable-themes-theme-id-assets-json description: REST surface for admin-api-unstable-themes-theme_id-assets.json. operations: - method: GET name: deprecatedunstablegetthemesparamthemeidassets description: Shopify Retrieves A Single Asset For A Theme By Its Key call: shopify-single.deprecatedunstablegetthemesparamthemeidassets with: theme_id: rest.theme_id fields: rest.fields asset[key]: rest.asset[key] outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/users/user-id-json name: admin-api-unstable-users-user-id-json description: REST surface for admin-api-unstable-users-user_id}.json. operations: - method: GET name: deprecatedunstablegetusersparamuserid description: Shopify Retrieves A Single User call: shopify-single.deprecatedunstablegetusersparamuserid with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/admin/api/unstable/webhooks/webhook-id-json name: admin-api-unstable-webhooks-webhook-id-json description: REST surface for admin-api-unstable-webhooks-webhook_id}.json. operations: - method: GET name: deprecatedunstablegetwebhooksparamwebhookid description: Shopify Retrieves A Single Webhook Subscription call: shopify-single.deprecatedunstablegetwebhooksparamwebhookid with: webhook_id: rest.webhook_id fields: rest.fields outputParameters: - type: object mapping: $. - type: mcp namespace: shopify-single-mcp port: 9090 transport: http description: MCP adapter for Shopify API — Single. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: shopify-retrieves-single-application-credit description: Shopify Retrieves A Single Application Credit hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getapplicationcreditsparamapplicationcreditid with: application_credit_id: tools.application_credit_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-get-single-blog-its description: Shopify Get A Single Blog By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getblogsparamblogid with: blog_id: tools.blog_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-comment-its description: Shopify Retrieves A Single Comment By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getcommentsparamcommentid with: comment_id: tools.comment_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer description: Shopify Retrieves A Single Customer hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getcustomersparamcustomerid with: customer_id: tools.customer_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001geteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-adjusts-inventory-level-inventory description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location hints: readOnly: false destructive: false idempotent: false call: shopify-single.deprecated202001createinventorylevelsadjust with: ? "inventory_item_id\n required" : "tools.inventory_item_id\n required" ? "location_id\n required" : "tools.location_id\n required" ? "available_adjustment\n required" : "tools.available_adjustment\n required" body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-get-single-product-image description: Shopify Get A Single Product Image By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getproductsparamproductidimagesparamimageid with: product_id: tools.product_id image_id: tools.image_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: tools.recurring_application_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-2 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: tools.recurring_application_charge_id usage_charge_id: tools.usage_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-report-created description: Shopify Retrieves A Single Report Created By Your App hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getreportsparamreportid with: report_id: tools.report_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-dispute-id description: Shopify Retrieves A Single Dispute By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getshopifypaymentsdisputesparamdisputeid with: dispute_id: tools.dispute_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202001getwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-application-credit-2 description: Shopify Retrieves A Single Application Credit hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getapplicationcreditsparamapplicationcreditid with: application_credit_id: tools.application_credit_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article-2 description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service-2 description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection-2 description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country-2 description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection-2 description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved-2 description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-2 description: Shopify Retrieves A Single Customer hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getcustomersparamcustomerid with: customer_id: tools.customer_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer-2 description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its-2 description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004geteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card-2 description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item-2 description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-adjusts-inventory-level-inventory-2 description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location hints: readOnly: false destructive: false idempotent: false call: shopify-single.deprecated202004createinventorylevelsadjust with: ? "inventory_item_id\n required" : "tools.inventory_item_id\n required" ? "location_id\n required" : "tools.location_id\n required" ? "available_adjustment\n required" : "tools.available_adjustment\n required" body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its-2 description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource-2 description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk-2 description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code-2 description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product-2 description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-get-single-product-image-2 description: Shopify Get A Single Product Image By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getproductsparamproductidimagesparamimageid with: product_id: tools.product_id image_id: tools.image_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-3 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: tools.recurring_application_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-4 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: tools.recurring_application_charge_id usage_charge_id: tools.usage_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect-2 description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-report-created-2 description: Shopify Retrieves A Single Report Created By Your App hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getreportsparamreportid with: report_id: tools.report_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag-2 description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id-2 description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection-2 description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme-2 description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme-2 description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user-2 description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription-2 description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202004getwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-application-credit-3 description: Shopify Retrieves A Single Application Credit hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getapplicationcreditsparamapplicationcreditid with: application_credit_id: tools.application_credit_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article-3 description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service-3 description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection-3 description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country-3 description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection-3 description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved-3 description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-3 description: Shopify Retrieves A Single Customer hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getcustomersparamcustomerid with: customer_id: tools.customer_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer-3 description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its-3 description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007geteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card-3 description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item-3 description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-adjusts-inventory-level-inventory-3 description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location hints: readOnly: false destructive: false idempotent: false call: shopify-single.deprecated202007createinventorylevelsadjust with: ? "inventory_item_id\n required" : "tools.inventory_item_id\n required" ? "location_id\n required" : "tools.location_id\n required" ? "available_adjustment\n required" : "tools.available_adjustment\n required" body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its-3 description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource-3 description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk-3 description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code-3 description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product-3 description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-get-single-product-image-3 description: Shopify Get A Single Product Image By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getproductsparamproductidimagesparamimageid with: product_id: tools.product_id image_id: tools.image_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-5 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: tools.recurring_application_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-6 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: tools.recurring_application_charge_id usage_charge_id: tools.usage_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect-3 description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-report-created-3 description: Shopify Retrieves A Single Report Created By Your App hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getreportsparamreportid with: report_id: tools.report_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag-3 description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id-3 description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection-3 description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme-3 description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme-3 description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user-3 description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription-3 description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202007getwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-application-credit-4 description: Shopify Retrieves A Single Application Credit hints: readOnly: true destructive: false idempotent: true call: shopify-single.getapplicationcreditsparamapplicationcreditid with: application_credit_id: tools.application_credit_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article-4 description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-single.getblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service-4 description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.getcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection-4 description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.getcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country-4 description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-single.getcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection-4 description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.getcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved-4 description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-single.getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-4 description: Shopify Retrieves A Single Customer hints: readOnly: true destructive: false idempotent: true call: shopify-single.getcustomersparamcustomerid with: customer_id: tools.customer_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer-4 description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-single.getcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its-4 description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.geteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card-4 description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.getgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item-4 description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.getinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-adjusts-inventory-level-inventory-4 description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location hints: readOnly: false destructive: false idempotent: false call: shopify-single.createinventorylevelsadjust with: ? "inventory_item_id\n required" : "tools.inventory_item_id\n required" ? "location_id\n required" : "tools.location_id\n required" ? "available_adjustment\n required" : "tools.available_adjustment\n required" body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its-4 description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.getlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource-4 description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.getmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk-4 description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.getordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code-4 description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-single.getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product-4 description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-single.getproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-get-single-product-image-4 description: Shopify Get A Single Product Image By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.getproductsparamproductidimagesparamimageid with: product_id: tools.product_id image_id: tools.image_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-7 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.getrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: tools.recurring_application_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-8 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: tools.recurring_application_charge_id usage_charge_id: tools.usage_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect-4 description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-single.getredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-report-created-4 description: Shopify Retrieves A Single Report Created By Your App hints: readOnly: true destructive: false idempotent: true call: shopify-single.getreportsparamreportid with: report_id: tools.report_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag-4 description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-single.getscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id-4 description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.getshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection-4 description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.getsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme-4 description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-single.getthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme-4 description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-single.getthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user-4 description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-single.getusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription-4 description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-single.getwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-application-credit-5 description: Shopify Retrieves A Single Application Credit hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getapplicationcreditsparamapplicationcreditid with: application_credit_id: tools.application_credit_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article-5 description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service-5 description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection-5 description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country-5 description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection-5 description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved-5 description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-5 description: Shopify Retrieves A Single Customer hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getcustomersparamcustomerid with: customer_id: tools.customer_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer-5 description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its-5 description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101geteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card-5 description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item-5 description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-adjusts-inventory-level-inventory-5 description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location hints: readOnly: false destructive: false idempotent: false call: shopify-single.deprecated202101createinventorylevelsadjust with: ? "inventory_item_id\n required" : "tools.inventory_item_id\n required" ? "location_id\n required" : "tools.location_id\n required" ? "available_adjustment\n required" : "tools.available_adjustment\n required" body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its-5 description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource-5 description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk-5 description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code-5 description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product-5 description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-get-single-product-image-5 description: Shopify Get A Single Product Image By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getproductsparamproductidimagesparamimageid with: product_id: tools.product_id image_id: tools.image_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-9 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: tools.recurring_application_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-10 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: tools.recurring_application_charge_id usage_charge_id: tools.usage_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect-5 description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-report-created-5 description: Shopify Retrieves A Single Report Created By Your App hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getreportsparamreportid with: report_id: tools.report_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag-5 description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id-5 description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection-5 description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme-5 description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme-5 description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user-5 description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription-5 description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecated202101getwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-application-credit-6 description: Shopify Retrieves A Single Application Credit hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetapplicationcreditsparamapplicationcreditid with: application_credit_id: tools.application_credit_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-article-6 description: Shopify Retrieves A Single Article hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetblogsparamblogidarticlesparamarticleid with: blog_id: tools.blog_id article_id: tools.article_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-carrier-service-6 description: Shopify Retrieves A Single Carrier Service By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetcarrierservicesparamcarrierserviceid with: carrier_service_id: tools.carrier_service_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-collection-6 description: Shopify Retrieves A Single Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetcollectionsparamcollectionid with: collection_id: tools.collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-province-country-6 description: Shopify Retrieves A Single Province For A Country hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetcountriesparamcountryidprovincesparamprovinceid with: country_id: tools.country_id province_id: tools.province_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-custom-collection-6 description: Shopify Retrieves A Single Custom Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetcustomcollectionsparamcustomcollectionid with: custom_collection_id: tools.custom_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-saved-6 description: Shopify Retrieves A Single Customer Saved Search hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetcustomersavedsearchesparamcustomersavedsearchid with: customer_saved_search_id: tools.customer_saved_search_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-customer-6 description: Shopify Retrieves A Single Customer hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetcustomersparamcustomerid with: customer_id: tools.customer_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-details-single-customer-6 description: Shopify Retrieves Details A Single Customer Address hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetcustomersparamcustomeridaddressesparamaddressid with: customer_id: tools.customer_id address_id: tools.address_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-event-its-6 description: Shopify Retrieves A Single Event By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegeteventsparameventid with: event_id: tools.event_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-gift-card-6 description: Shopify Retrieves A Single Gift Card By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetgiftcardsparamgiftcardid with: gift_card_id: tools.gift_card_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-inventory-item-6 description: Shopify Retrieves A Single Inventory Item By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetinventoryitemsparaminventoryitemid with: inventory_item_id: tools.inventory_item_id outputParameters: - type: object mapping: $. - name: shopify-adjusts-inventory-level-inventory-6 description: Shopify Adjusts The Inventory Level Of An Inventory Item At A Single Location hints: readOnly: false destructive: false idempotent: false call: shopify-single.deprecatedunstablecreateinventorylevelsadjust with: ? "inventory_item_id\n required" : "tools.inventory_item_id\n required" ? "location_id\n required" : "tools.location_id\n required" ? "available_adjustment\n required" : "tools.available_adjustment\n required" body: tools.body outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-location-its-6 description: Shopify Retrieves A Single Location By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetlocationsparamlocationid with: location_id: tools.location_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-metafield-resource-6 description: Shopify Retrieves A Single Metafield From A Resource By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetmetafieldsparammetafieldid with: metafield_id: tools.metafield_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-order-risk-6 description: Shopify Retrieves A Single Order Risk By Its Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetordersparamorderidrisksparamriskid with: order_id: tools.order_id risk_id: tools.risk_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-discount-code-6 description: Shopify Retrieves A Single Discount Code hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetpricerulesparampriceruleiddiscountcodesparamdiscountcodeid with: price_rule_id: tools.price_rule_id discount_code_id: tools.discount_code_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-product-6 description: Shopify Retrieves A Single Product hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetproductsparamproductid with: product_id: tools.product_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-get-single-product-image-6 description: Shopify Get A Single Product Image By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetproductsparamproductidimagesparamimageid with: product_id: tools.product_id image_id: tools.image_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-11 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeid with: recurring_application_charge_id: tools.recurring_application_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-charge-12 description: Shopify Retrieves A Single Charge hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetrecurringapplicationchargesparamrecurringapplicationchargeidusagechargesparamusagechargeid with: recurring_application_charge_id: tools.recurring_application_charge_id usage_charge_id: tools.usage_charge_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-redirect-6 description: Shopify Retrieves A Single Redirect hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetredirectsparamredirectid with: redirect_id: tools.redirect_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-report-created-6 description: Shopify Retrieves A Single Report Created By Your App hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetreportsparamreportid with: report_id: tools.report_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-script-tag-6 description: Shopify Retrieves A Single Script Tag hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetscripttagsparamscripttagid with: script_tag_id: tools.script_tag_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-payout-id-6 description: Shopify Retrieves A Single Payout By Id hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetshopifypaymentspayoutsparampayoutid with: payout_id: tools.payout_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-smart-collection-6 description: Shopify Retrieves A Single Smart Collection hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetsmartcollectionsparamsmartcollectionid with: smart_collection_id: tools.smart_collection_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-theme-6 description: Shopify Retrieves A Single Theme hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetthemesparamthemeid with: theme_id: tools.theme_id fields: tools.fields outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-asset-theme-6 description: Shopify Retrieves A Single Asset For A Theme By Its Key hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetthemesparamthemeidassets with: theme_id: tools.theme_id fields: tools.fields asset[key]: tools.asset[key] outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-user-6 description: Shopify Retrieves A Single User hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetusersparamuserid with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: shopify-retrieves-single-webhook-subscription-6 description: Shopify Retrieves A Single Webhook Subscription hints: readOnly: true destructive: false idempotent: true call: shopify-single.deprecatedunstablegetwebhooksparamwebhookid with: webhook_id: tools.webhook_id fields: tools.fields outputParameters: - type: object mapping: $.