{ "opencollection": "1.0.0", "info": { "name": "Shopify Admin REST About Applications API", "version": "2025-01" }, "request": { "auth": { "type": "apikey", "key": "X-Shopify-Access-Token", "value": "{{X-Shopify-Access-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-01" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-01" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-04" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-04" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-07" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-07" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-10" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-10" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2021-01" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2021-01" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-unstable" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-unstable" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-unstable" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-01" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-01" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-04" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-04" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-07" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-07" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-10" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-10" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2021-01" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2021-01" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-unstable" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-01" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2020-01" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2020-01" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-04" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2020-04" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2020-04" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-07" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2020-07" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2020-07" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-10" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2020-10" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2020-10" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2021-01" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2021-01" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2021-01" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-unstable" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-unstable" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-unstable" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/deprecated_api_calls.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/deprecated_api_calls#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/deprecated_api_calls.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/deprecated_api_calls#index-unstable" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-01" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-01" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-04" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-04" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-07" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-07" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-10" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-10" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2021-01" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2021-01" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-unstable" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-unstable" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-01" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-01" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-01" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-01" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-04" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-04" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-04" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-04" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-07" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-07" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-07" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-07" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-10" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-10" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-10" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-10" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2021-01" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2021-01" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2021-01" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2021-01" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-unstable" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-unstable" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-unstable" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-unstable" }, { "info": { "name": "Shopify Retrieve Product Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/product_listings.json", "params": [ { "name": "product_ids", "value": "", "type": "query", "description": "A comma-separated list of product ids" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter by products belonging to a particular collection" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Filter by products last updated after a certain date and time (formatted in ISO 8601)" }, { "name": "handle", "value": "", "type": "query", "description": "Filter by product handle" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-01" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/product_listings/product_ids.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#product_ids-2020-01" }, { "info": { "name": "Shopify Retrieve A Count Of Products That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/product_listings/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#count-2020-01" }, { "info": { "name": "Shopify Retrieve A Specific Product Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-01" }, { "info": { "name": "Shopify Create A Product Listing To Publish A Product To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-01" }, { "info": { "name": "Shopify Delete A Product Listing To Unpublish A Product From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-01" }, { "info": { "name": "Shopify Retrieve Product Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/product_listings.json", "params": [ { "name": "product_ids", "value": "", "type": "query", "description": "A comma-separated list of product ids" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter by products belonging to a particular collection" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Filter by products last updated after a certain date and time (formatted in ISO 8601)" }, { "name": "handle", "value": "", "type": "query", "description": "Filter by product handle" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-04" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/product_listings/product_ids.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#product_ids-2020-04" }, { "info": { "name": "Shopify Retrieve A Count Of Products That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/product_listings/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#count-2020-04" }, { "info": { "name": "Shopify Retrieve A Specific Product Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-04" }, { "info": { "name": "Shopify Create A Product Listing To Publish A Product To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-04" }, { "info": { "name": "Shopify Delete A Product Listing To Unpublish A Product From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-04" }, { "info": { "name": "Shopify Retrieve Product Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/product_listings.json", "params": [ { "name": "product_ids", "value": "", "type": "query", "description": "A comma-separated list of product ids" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter by products belonging to a particular collection" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Filter by products last updated after a certain date and time (formatted in ISO 8601)" }, { "name": "handle", "value": "", "type": "query", "description": "Filter by product handle" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-07" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/product_listings/product_ids.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#product_ids-2020-07" }, { "info": { "name": "Shopify Retrieve A Count Of Products That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/product_listings/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#count-2020-07" }, { "info": { "name": "Shopify Retrieve A Specific Product Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-07" }, { "info": { "name": "Shopify Create A Product Listing To Publish A Product To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-07" }, { "info": { "name": "Shopify Delete A Product Listing To Unpublish A Product From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/assigned_fulfillment_orders.json", "params": [ { "name": "assignment_status", "value": "", "type": "query", "description": "The assigment status of the fulfillment orders that should be returned:\n \n cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.\n fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.\n fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items." }, { "name": "location_ids", "value": "", "type": "query", "description": "The IDs of the assigned locations of the fulfillment orders that should be returned." }, { "name": "location_ids[]", "value": "", "type": "query", "description": "location_ids[]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/assigned_fulfillment_orders.json", "params": [ { "name": "assignment_status", "value": "", "type": "query", "description": "The assigment status of the fulfillment orders that should be returned:\n \n cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.\n fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.\n fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items." }, { "name": "location_ids", "value": "", "type": "query", "description": "The IDs of the assigned locations of the fulfillment orders that should be returned." }, { "name": "location_ids[]", "value": "", "type": "query", "description": "location_ids[]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/assigned_fulfillment_orders.json", "params": [ { "name": "assignment_status", "value": "", "type": "query", "description": "The assigment status of the fulfillment orders that should be returned:\n \n cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.\n fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.\n fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items." }, { "name": "location_ids", "value": "", "type": "query", "description": "The IDs of the assigned locations of the fulfillment orders that should be returned." }, { "name": "location_ids[]", "value": "", "type": "query", "description": "location_ids[]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/assigned_fulfillment_orders.json", "params": [ { "name": "assignment_status", "value": "", "type": "query", "description": "The assigment status of the fulfillment orders that should be returned:\n \n cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.\n fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.\n fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items." }, { "name": "location_ids", "value": "", "type": "query", "description": "The IDs of the assigned locations of the fulfillment orders that should be returned." }, { "name": "location_ids[]", "value": "", "type": "query", "description": "location_ids[]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/assigned_fulfillment_orders.json", "params": [ { "name": "assignment_status", "value": "", "type": "query", "description": "The assigment status of the fulfillment orders that should be returned:\n \n cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.\n fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.\n fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items." }, { "name": "location_ids", "value": "", "type": "query", "description": "The IDs of the assigned locations of the fulfillment orders that should be returned." }, { "name": "location_ids[]", "value": "", "type": "query", "description": "location_ids[]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/assigned_fulfillment_orders.json", "params": [ { "name": "assignment_status", "value": "", "type": "query", "description": "The assigment status of the fulfillment orders that should be returned:\n \n cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.\n fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.\n fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items." }, { "name": "location_ids", "value": "", "type": "query", "description": "The IDs of the assigned locations of the fulfillment orders that should be returned." }, { "name": "location_ids[]", "value": "", "type": "query", "description": "location_ids[]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-unstable" } ] } ], "bundled": true }