{ "opencollection": "1.0.0", "info": { "name": "Shopify Admin REST About Lists API", "version": "2025-01" }, "request": { "auth": { "type": "apikey", "key": "X-Shopify-Access-Token", "value": "{{X-Shopify-Access-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Lists", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Access Scopes Associated To The Access Token", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/oauth/access_scopes.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/accessscope#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/storefront_access_tokens.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/storefront_access_tokens.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/storefront_access_tokens.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/storefront_access_tokens.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/storefront_access_tokens.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/storefront_access_tokens.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Reports", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/reports.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of report IDs." }, { "name": "limit", "value": "", "type": "query", "description": "The amount of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show reports last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "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#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Reports", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/reports.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of report IDs." }, { "name": "limit", "value": "", "type": "query", "description": "The amount of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show reports last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "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#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Reports", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/reports.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of report IDs." }, { "name": "limit", "value": "", "type": "query", "description": "The amount of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show reports last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "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#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Reports", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/reports.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of report IDs." }, { "name": "limit", "value": "", "type": "query", "description": "The amount of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show reports last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "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#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Reports", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/reports.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of report IDs." }, { "name": "limit", "value": "", "type": "query", "description": "The amount of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show reports last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "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#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Reports", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/reports.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of report IDs." }, { "name": "limit", "value": "", "type": "query", "description": "The amount of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show reports last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "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#index-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 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 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 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 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 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 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 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 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 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 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 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 Retrieves A List Of Usage Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/recurring_application_charges/:recurring_application_charge_id/usage_charges.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_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/usagecharge#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Usage Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/recurring_application_charges/:recurring_application_charge_id/usage_charges.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_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/usagecharge#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Usage Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/recurring_application_charges/:recurring_application_charge_id/usage_charges.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_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/usagecharge#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Usage Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/recurring_application_charges/:recurring_application_charge_id/usage_charges.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_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/usagecharge#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Usage Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/recurring_application_charges/:recurring_application_charge_id/usage_charges.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_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/usagecharge#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Usage Charges", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/recurring_application_charges/:recurring_application_charge_id/usage_charges.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_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/usagecharge#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-01" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#destroy-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-04" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#destroy-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-07" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-10" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#destroy-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2021-01" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#destroy-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-unstable" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#destroy-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-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 Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/price_rules/:price_rule_id/batch/:batch_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "batch_id", "value": "", "type": "path", "description": "batch_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-01" }, { "info": { "name": "Shopify Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/price_rules/:price_rule_id/batch/:batch_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "batch_id", "value": "", "type": "path", "description": "batch_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-04" }, { "info": { "name": "Shopify Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/price_rules/:price_rule_id/batch/:batch_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "batch_id", "value": "", "type": "path", "description": "batch_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-07" }, { "info": { "name": "Shopify Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/price_rules/:price_rule_id/batch/:batch_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "batch_id", "value": "", "type": "path", "description": "batch_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-10" }, { "info": { "name": "Shopify Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/price_rules/:price_rule_id/batch/:batch_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "batch_id", "value": "", "type": "path", "description": "batch_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2021-01" }, { "info": { "name": "Shopify Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/price_rules/:price_rule_id/batch/:batch_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "batch_id", "value": "", "type": "path", "description": "batch_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/events.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Show only results after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "filter", "value": "", "type": "query", "description": "Show events specified in this filter." }, { "name": "verb", "value": "", "type": "query", "description": "Show events of a certain type." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/events.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Show only results after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "filter", "value": "", "type": "query", "description": "Show events specified in this filter." }, { "name": "verb", "value": "", "type": "query", "description": "Show events of a certain type." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/events.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Show only results after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "filter", "value": "", "type": "query", "description": "Show events specified in this filter." }, { "name": "verb", "value": "", "type": "query", "description": "Show events of a certain type." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/events.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Show only results after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "filter", "value": "", "type": "query", "description": "Show events specified in this filter." }, { "name": "verb", "value": "", "type": "query", "description": "Show events of a certain type." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/events.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Show only results after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "filter", "value": "", "type": "query", "description": "Show events specified in this filter." }, { "name": "verb", "value": "", "type": "query", "description": "Show events of a certain type." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/events.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Show only results after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "filter", "value": "", "type": "query", "description": "Show events specified in this filter." }, { "name": "verb", "value": "", "type": "query", "description": "Show events of a certain type." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/webhooks.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "fields", "value": "", "type": "query", "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 those properties you specify." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/webhooks.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "fields", "value": "", "type": "query", "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 those properties you specify." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/webhooks.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "fields", "value": "", "type": "query", "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 those properties you specify." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/webhooks.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "fields", "value": "", "type": "query", "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 those properties you specify." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/webhooks.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "fields", "value": "", "type": "query", "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 those properties you specify." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/webhooks.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "fields", "value": "", "type": "query", "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 those properties you specify." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Items", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/inventory_items.json", "params": [ { "name": "ids\n required", "value": "", "type": "query", "description": "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "ids" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Items", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/inventory_items.json", "params": [ { "name": "ids\n required", "value": "", "type": "query", "description": "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "ids" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Items", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/inventory_items.json", "params": [ { "name": "ids\n required", "value": "", "type": "query", "description": "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "ids" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Items", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/inventory_items.json", "params": [ { "name": "ids\n required", "value": "", "type": "query", "description": "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "ids" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Items", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/inventory_items.json", "params": [ { "name": "ids\n required", "value": "", "type": "query", "description": "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "ids" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Items", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/inventory_items.json", "params": [ { "name": "ids\n required", "value": "", "type": "query", "description": "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "ids" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/inventory_levels.json", "params": [ { "name": "inventory_item_ids", "value": "", "type": "query", "description": "A comma-separated list of inventory item IDs.\n (maximum: 50)" }, { "name": "location_ids", "value": "", "type": "query", "description": "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/inventory_levels.json", "params": [ { "name": "inventory_item_ids", "value": "", "type": "query", "description": "A comma-separated list of inventory item IDs.\n (maximum: 50)" }, { "name": "location_ids", "value": "", "type": "query", "description": "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/inventory_levels.json", "params": [ { "name": "inventory_item_ids", "value": "", "type": "query", "description": "A comma-separated list of inventory item IDs.\n (maximum: 50)" }, { "name": "location_ids", "value": "", "type": "query", "description": "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/inventory_levels.json", "params": [ { "name": "inventory_item_ids", "value": "", "type": "query", "description": "A comma-separated list of inventory item IDs.\n (maximum: 50)" }, { "name": "location_ids", "value": "", "type": "query", "description": "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/inventory_levels.json", "params": [ { "name": "inventory_item_ids", "value": "", "type": "query", "description": "A comma-separated list of inventory item IDs.\n (maximum: 50)" }, { "name": "location_ids", "value": "", "type": "query", "description": "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/inventory_levels.json", "params": [ { "name": "inventory_item_ids", "value": "", "type": "query", "description": "A comma-separated list of inventory item IDs.\n (maximum: 50)" }, { "name": "location_ids", "value": "", "type": "query", "description": "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Locations", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/locations.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/locations/:location_id/inventory_levels.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Locations", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/locations.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/locations/:location_id/inventory_levels.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Locations", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/locations.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/locations/:location_id/inventory_levels.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Locations", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/locations.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/locations/:location_id/inventory_levels.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Locations", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/locations.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/locations/:location_id/inventory_levels.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Locations", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/locations.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/locations/:location_id/inventory_levels.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Retrieve results based on their published status.\n (default: any)\n \n published: Show only published articles.\n unpublished: Show only unpublished articles.\n any: Show articles of any published status." }, { "name": "handle", "value": "", "type": "query", "description": "Retrieve an article with a specific handle." }, { "name": "tag", "value": "", "type": "query", "description": "Filter articles with a specific tag." }, { "name": "author", "value": "", "type": "query", "description": "Filter articles by article author." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/articles/authors.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of All The Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/articles/tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of tags to retrieve." }, { "name": "popular", "value": "", "type": "query", "description": "A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Retrieve results based on their published status.\n (default: any)\n \n published: Show only published articles.\n unpublished: Show only unpublished articles.\n any: Show articles of any published status." }, { "name": "handle", "value": "", "type": "query", "description": "Retrieve an article with a specific handle." }, { "name": "tag", "value": "", "type": "query", "description": "Filter articles with a specific tag." }, { "name": "author", "value": "", "type": "query", "description": "Filter articles by article author." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/articles/authors.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of All The Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/articles/tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of tags to retrieve." }, { "name": "popular", "value": "", "type": "query", "description": "A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Retrieve results based on their published status.\n (default: any)\n \n published: Show only published articles.\n unpublished: Show only unpublished articles.\n any: Show articles of any published status." }, { "name": "handle", "value": "", "type": "query", "description": "Retrieve an article with a specific handle." }, { "name": "tag", "value": "", "type": "query", "description": "Filter articles with a specific tag." }, { "name": "author", "value": "", "type": "query", "description": "Filter articles by article author." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/articles/authors.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of All The Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/articles/tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of tags to retrieve." }, { "name": "popular", "value": "", "type": "query", "description": "A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Retrieve results based on their published status.\n (default: any)\n \n published: Show only published articles.\n unpublished: Show only unpublished articles.\n any: Show articles of any published status." }, { "name": "handle", "value": "", "type": "query", "description": "Retrieve an article with a specific handle." }, { "name": "tag", "value": "", "type": "query", "description": "Filter articles with a specific tag." }, { "name": "author", "value": "", "type": "query", "description": "Filter articles by article author." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/articles/authors.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of All The Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/articles/tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of tags to retrieve." }, { "name": "popular", "value": "", "type": "query", "description": "A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Retrieve results based on their published status.\n (default: any)\n \n published: Show only published articles.\n unpublished: Show only unpublished articles.\n any: Show articles of any published status." }, { "name": "handle", "value": "", "type": "query", "description": "Retrieve an article with a specific handle." }, { "name": "tag", "value": "", "type": "query", "description": "Filter articles with a specific tag." }, { "name": "author", "value": "", "type": "query", "description": "Filter articles by article author." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/articles/authors.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of All The Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/articles/tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of tags to retrieve." }, { "name": "popular", "value": "", "type": "query", "description": "A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Retrieve results based on their published status.\n (default: any)\n \n published: Show only published articles.\n unpublished: Show only unpublished articles.\n any: Show articles of any published status." }, { "name": "handle", "value": "", "type": "query", "description": "Retrieve an article with a specific handle." }, { "name": "tag", "value": "", "type": "query", "description": "Filter articles with a specific tag." }, { "name": "author", "value": "", "type": "query", "description": "Filter articles by article author." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-unstable" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/articles/authors.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-unstable" }, { "info": { "name": "Shopify Retrieves A List Of All The Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/articles/tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of tags to retrieve." }, { "name": "popular", "value": "", "type": "query", "description": "A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-unstable" }, { "info": { "name": "Shopify Retrieve A List Of All Blogs", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/blogs.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "name": "handle", "value": "", "type": "query", "description": "Filter by blog handle" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Comments", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/comments.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show comments created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show comments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show comments last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show comments last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show comments published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show comments published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "published_status", "value": "", "type": "query", "description": "Filter results by their published status.\n (default: any)\n \n published: Show only published comments.\n unpublished: Show only unpublished comments.\n any: Show comments of any published status." }, { "name": "status", "value": "", "type": "query", "description": "Filter results by their status.\n \n pending: Show only pending comments.\n published: Show only published comments.\n unapproved: Show only unapproved comments." }, { "name": "article_id", "value": "", "type": "query", "description": "article_id" }, { "name": "blog_id", "value": "", "type": "query", "description": "blog_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/redirects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "path", "value": "", "type": "query", "description": "Show redirects with a given path." }, { "name": "target", "value": "", "type": "query", "description": "Show redirects with a given target." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/redirects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "path", "value": "", "type": "query", "description": "Show redirects with a given path." }, { "name": "target", "value": "", "type": "query", "description": "Show redirects with a given target." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/redirects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "path", "value": "", "type": "query", "description": "Show redirects with a given path." }, { "name": "target", "value": "", "type": "query", "description": "Show redirects with a given target." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/redirects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "path", "value": "", "type": "query", "description": "Show redirects with a given path." }, { "name": "target", "value": "", "type": "query", "description": "Show redirects with a given target." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/redirects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "path", "value": "", "type": "query", "description": "Show redirects with a given path." }, { "name": "target", "value": "", "type": "query", "description": "Show redirects with a given target." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/redirects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "path", "value": "", "type": "query", "description": "Show redirects with a given path." }, { "name": "target", "value": "", "type": "query", "description": "Show redirects with a given target." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/script_tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "src", "value": "", "type": "query", "description": "Show script tags with this URL." }, { "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/online-store/scripttag#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/script_tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "src", "value": "", "type": "query", "description": "Show script tags with this URL." }, { "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/online-store/scripttag#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/script_tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "src", "value": "", "type": "query", "description": "Show script tags with this URL." }, { "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/online-store/scripttag#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/script_tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "src", "value": "", "type": "query", "description": "Show script tags with this URL." }, { "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/online-store/scripttag#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/script_tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "src", "value": "", "type": "query", "description": "Show script tags with this URL." }, { "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/online-store/scripttag#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/script_tags.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to return.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "src", "value": "", "type": "query", "description": "Show script tags with this URL." }, { "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/online-store/scripttag#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Themes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/themes.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Themes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/themes.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Themes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/themes.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Themes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/themes.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Themes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/themes.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Themes", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/themes.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Orders", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/orders.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Retrieve only orders specified by a comma-separated list of order IDs." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Show orders after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show orders created at or after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show orders created at or before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "processed_at_min", "value": "", "type": "query", "description": "Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "processed_at_max", "value": "", "type": "query", "description": "Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "attribution_app_id", "value": "", "type": "query", "description": "Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for the app currently consuming the API." }, { "name": "status", "value": "", "type": "query", "description": "Filter orders by their status.\n (default: open)\n \n open: Show only open orders.\n closed: Show only closed orders.\n cancelled: Show only canceled orders.\n any: Show orders of any status, including archived orders." }, { "name": "financial_status", "value": "", "type": "query", "description": "Filter orders by their financial status.\n (default: any)\n \n authorized: Show only authorized orders\n pending: Show only pending orders\n paid: Show only paid orders\n partially_paid: Show only partially paid orders\n refunded: Show only refunded orders\n voided: Show only voided orders\n partially_refunded: Show only partially refunded orders\n any: Show orders of any financial status.\n unpaid: Show authorized and partially paid orders." }, { "name": "fulfillment_status", "value": "", "type": "query", "description": "Filter orders by their fulfillment status.\n (default: any)\n \n shipped: Show orders that have been shipped. Returns orders with fulfillment_status of fulfilled.\n partial: Show partially shipped orders.\n unshipped: Show orders that have not yet been shipped. Returns orders with fulfillment_status of null.\n any: Show orders of any fulfillment status.\n unfulfilled: Returns orders with fulfillment_status of null or partial." }, { "name": "fields", "value": "", "type": "query", "description": "Retrieve only certain fields, specified by a comma-separated list of fields names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Orders", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/orders.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Retrieve only orders specified by a comma-separated list of order IDs." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Show orders after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show orders created at or after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show orders created at or before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "processed_at_min", "value": "", "type": "query", "description": "Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "processed_at_max", "value": "", "type": "query", "description": "Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "attribution_app_id", "value": "", "type": "query", "description": "Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for the app currently consuming the API." }, { "name": "status", "value": "", "type": "query", "description": "Filter orders by their status.\n (default: open)\n \n open: Show only open orders.\n closed: Show only closed orders.\n cancelled: Show only canceled orders.\n any: Show orders of any status, including archived orders." }, { "name": "financial_status", "value": "", "type": "query", "description": "Filter orders by their financial status.\n (default: any)\n \n authorized: Show only authorized orders\n pending: Show only pending orders\n paid: Show only paid orders\n partially_paid: Show only partially paid orders\n refunded: Show only refunded orders\n voided: Show only voided orders\n partially_refunded: Show only partially refunded orders\n any: Show orders of any financial status.\n unpaid: Show authorized and partially paid orders." }, { "name": "fulfillment_status", "value": "", "type": "query", "description": "Filter orders by their fulfillment status.\n (default: any)\n \n shipped: Show orders that have been shipped. Returns orders with fulfillment_status of fulfilled.\n partial: Show partially shipped orders.\n unshipped: Show orders that have not yet been shipped. Returns orders with fulfillment_status of null.\n any: Show orders of any fulfillment status.\n unfulfilled: Returns orders with fulfillment_status of null or partial." }, { "name": "fields", "value": "", "type": "query", "description": "Retrieve only certain fields, specified by a comma-separated list of fields names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Orders", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/orders.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Retrieve only orders specified by a comma-separated list of order IDs." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Show orders after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show orders created at or after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show orders created at or before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "processed_at_min", "value": "", "type": "query", "description": "Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "processed_at_max", "value": "", "type": "query", "description": "Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "attribution_app_id", "value": "", "type": "query", "description": "Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for the app currently consuming the API." }, { "name": "status", "value": "", "type": "query", "description": "Filter orders by their status.\n (default: open)\n \n open: Show only open orders.\n closed: Show only closed orders.\n cancelled: Show only canceled orders.\n any: Show orders of any status, including archived orders." }, { "name": "financial_status", "value": "", "type": "query", "description": "Filter orders by their financial status.\n (default: any)\n \n authorized: Show only authorized orders\n pending: Show only pending orders\n paid: Show only paid orders\n partially_paid: Show only partially paid orders\n refunded: Show only refunded orders\n voided: Show only voided orders\n partially_refunded: Show only partially refunded orders\n any: Show orders of any financial status.\n unpaid: Show authorized and partially paid orders." }, { "name": "fulfillment_status", "value": "", "type": "query", "description": "Filter orders by their fulfillment status.\n (default: any)\n \n shipped: Show orders that have been shipped. Returns orders with fulfillment_status of fulfilled.\n partial: Show partially shipped orders.\n unshipped: Show orders that have not yet been shipped. Returns orders with fulfillment_status of null.\n any: Show orders of any fulfillment status.\n unfulfilled: Returns orders with fulfillment_status of null or partial." }, { "name": "fields", "value": "", "type": "query", "description": "Retrieve only certain fields, specified by a comma-separated list of fields names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of All Order Risks For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of All Order Risks For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of All Order Risks For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of All Order Risks For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of All Order Risks For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of All Order Risks For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Refunds For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "in_shop_currency", "value": "", "type": "query", "description": "Show amounts in the shop currency for the underlying transaction.\n (default: false)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Refunds For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "in_shop_currency", "value": "", "type": "query", "description": "Show amounts in the shop currency for the underlying transaction.\n (default: false)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Refunds For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "in_shop_currency", "value": "", "type": "query", "description": "Show amounts in the shop currency for the underlying transaction.\n (default: false)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Refunds For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "in_shop_currency", "value": "", "type": "query", "description": "Show amounts in the shop currency for the underlying transaction.\n (default: false)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Refunds For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "in_shop_currency", "value": "", "type": "query", "description": "Show amounts in the shop currency for the underlying transaction.\n (default: false)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Refunds For An Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "in_shop_currency", "value": "", "type": "query", "description": "Show amounts in the shop currency for the underlying transaction.\n (default: false)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/gift_cards.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Retrieve gift cards with a given status. Valid values:\n \n enabled: Restrict results to only enabled gift cards\n disabled: Restrict results to only disabled gift cards" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/gift_cards.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Retrieve gift cards with a given status. Valid values:\n \n enabled: Restrict results to only enabled gift cards\n disabled: Restrict results to only disabled gift cards" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/gift_cards.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Retrieve gift cards with a given status. Valid values:\n \n enabled: Restrict results to only enabled gift cards\n disabled: Restrict results to only disabled gift cards" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/gift_cards.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Retrieve gift cards with a given status. Valid values:\n \n enabled: Restrict results to only enabled gift cards\n disabled: Restrict results to only disabled gift cards" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/gift_cards.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Retrieve gift cards with a given status. Valid values:\n \n enabled: Restrict results to only enabled gift cards\n disabled: Restrict results to only disabled gift cards" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/gift_cards.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Retrieve gift cards with a given status. Valid values:\n \n enabled: Restrict results to only enabled gift cards\n disabled: Restrict results to only disabled gift cards" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of All Users", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/users.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" }, { "name": "page_info", "value": "", "type": "query", "description": "A unique ID used to access a certain page of results." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of All Users", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/users.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" }, { "name": "page_info", "value": "", "type": "query", "description": "A unique ID used to access a certain page of results." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of All Users", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/users.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" }, { "name": "page_info", "value": "", "type": "query", "description": "A unique ID used to access a certain page of results." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of All Users", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/users.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" }, { "name": "page_info", "value": "", "type": "query", "description": "A unique ID used to access a certain page of results." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of All Users", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/users.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" }, { "name": "page_info", "value": "", "type": "query", "description": "A unique ID used to access a certain page of results." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of All Users", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/users.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" }, { "name": "page_info", "value": "", "type": "query", "description": "A unique ID used to access a certain page of results." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Collects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/collects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Collects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/collects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Collects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/collects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Collects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/collects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Collects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/collects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Collects", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/collects.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-unstable" }, { "info": { "name": "Shopify Retrieve A List Of Products Belonging To A Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/collections/:collection_id/products.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_id" }, { "name": "limit", "value": "", "type": "query", "description": "The number of products to retrieve.\n (default: 50, maximum: 250)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2020-01" }, { "info": { "name": "Shopify Retrieve A List Of Products Belonging To A Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/collections/:collection_id/products.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_id" }, { "name": "limit", "value": "", "type": "query", "description": "The number of products to retrieve.\n (default: 50, maximum: 250)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2020-04" }, { "info": { "name": "Shopify Retrieve A List Of Products Belonging To A Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/collections/:collection_id/products.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_id" }, { "name": "limit", "value": "", "type": "query", "description": "The number of products to retrieve.\n (default: 50, maximum: 250)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2020-07" }, { "info": { "name": "Shopify Retrieve A List Of Products Belonging To A Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/collections/:collection_id/products.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_id" }, { "name": "limit", "value": "", "type": "query", "description": "The number of products to retrieve.\n (default: 50, maximum: 250)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2020-10" }, { "info": { "name": "Shopify Retrieve A List Of Products Belonging To A Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/collections/:collection_id/products.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_id" }, { "name": "limit", "value": "", "type": "query", "description": "The number of products to retrieve.\n (default: 50, maximum: 250)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2021-01" }, { "info": { "name": "Shopify Retrieve A List Of Products Belonging To A Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/collections/:collection_id/products.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_id" }, { "name": "limit", "value": "", "type": "query", "description": "The number of products to retrieve.\n (default: 50, maximum: 250)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Products", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Return only products specified by a comma-separated list of product IDs." }, { "name": "limit", "value": "", "type": "query", "description": "Return up to this many results per page.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Filter results by product title." }, { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by product handle." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "status", "value": "", "type": "query", "description": "Return products by their status.\n (default: active)\n \n active: Show only active products.\n archived: Show only archived products.\n draft: Show only draft products." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by product collection ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show products created after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show products created before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show products published after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show products published before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Return products by their published status\n (default: any)\n \n published: Show only published products.\n unpublished: Show only unpublished products.\n any: Show all products." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "presentment_currencies", "value": "", "type": "query", "description": "Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Products", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Return only products specified by a comma-separated list of product IDs." }, { "name": "limit", "value": "", "type": "query", "description": "Return up to this many results per page.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Filter results by product title." }, { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by product handle." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "status", "value": "", "type": "query", "description": "Return products by their status.\n (default: active)\n \n active: Show only active products.\n archived: Show only archived products.\n draft: Show only draft products." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by product collection ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show products created after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show products created before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show products published after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show products published before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Return products by their published status\n (default: any)\n \n published: Show only published products.\n unpublished: Show only unpublished products.\n any: Show all products." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "presentment_currencies", "value": "", "type": "query", "description": "Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Products", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Return only products specified by a comma-separated list of product IDs." }, { "name": "limit", "value": "", "type": "query", "description": "Return up to this many results per page.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Filter results by product title." }, { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by product handle." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "status", "value": "", "type": "query", "description": "Return products by their status.\n (default: active)\n \n active: Show only active products.\n archived: Show only archived products.\n draft: Show only draft products." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by product collection ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show products created after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show products created before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show products published after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show products published before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Return products by their published status\n (default: any)\n \n published: Show only published products.\n unpublished: Show only unpublished products.\n any: Show all products." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "presentment_currencies", "value": "", "type": "query", "description": "Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Products", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Return only products specified by a comma-separated list of product IDs." }, { "name": "limit", "value": "", "type": "query", "description": "Return up to this many results per page.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Filter results by product title." }, { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by product handle." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "status", "value": "", "type": "query", "description": "Return products by their status.\n (default: active)\n \n active: Show only active products.\n archived: Show only archived products.\n draft: Show only draft products." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by product collection ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show products created after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show products created before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show products published after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show products published before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Return products by their published status\n (default: any)\n \n published: Show only published products.\n unpublished: Show only unpublished products.\n any: Show all products." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "presentment_currencies", "value": "", "type": "query", "description": "Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Products", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Return only products specified by a comma-separated list of product IDs." }, { "name": "limit", "value": "", "type": "query", "description": "Return up to this many results per page.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Filter results by product title." }, { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by product handle." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "status", "value": "", "type": "query", "description": "Return products by their status.\n (default: active)\n \n active: Show only active products.\n archived: Show only archived products.\n draft: Show only draft products." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by product collection ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show products created after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show products created before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show products published after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show products published before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Return products by their published status\n (default: any)\n \n published: Show only published products.\n unpublished: Show only unpublished products.\n any: Show all products." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "presentment_currencies", "value": "", "type": "query", "description": "Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Products", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Return only products specified by a comma-separated list of product IDs." }, { "name": "limit", "value": "", "type": "query", "description": "Return up to this many results per page.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Filter results by product title." }, { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by product handle." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "status", "value": "", "type": "query", "description": "Return products by their status.\n (default: active)\n \n active: Show only active products.\n archived: Show only archived products.\n draft: Show only draft products." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by product collection ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show products created after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show products created before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show products published after date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show products published before date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Return products by their published status\n (default: any)\n \n published: Show only published products.\n unpublished: Show only unpublished products.\n any: Show all products." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." }, { "name": "presentment_currencies", "value": "", "type": "query", "description": "Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/smart_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only the smart collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that includes the specified product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by smart collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/smart_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only the smart collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that includes the specified product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by smart collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/smart_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only the smart collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that includes the specified product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by smart collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/smart_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only the smart collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that includes the specified product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by smart collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/smart_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only the smart collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that includes the specified product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by smart collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/smart_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results to show.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only the smart collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that includes the specified product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter results by smart collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "published_status", "value": "", "type": "query", "description": "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/checkouts/:token/shipping_rates.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/checkouts/:token/shipping_rates.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/checkouts/:token/shipping_rates.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/checkouts/:token/shipping_rates.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/checkouts/:token/shipping_rates.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/checkouts/:token/shipping_rates.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-unstable" }, { "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" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/carrier_services.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/carrier_services.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/carrier_services.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/carrier_services.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/carrier_services.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/carrier_services.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/orders/:order_id/fulfillments/:fulfillment_id/events.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "fulfillment_id", "value": "", "type": "query", "description": "The ID of the fulfillment that's associated with the fulfillment event." }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that's associated with the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/orders/:order_id/fulfillments/:fulfillment_id/events.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "fulfillment_id", "value": "", "type": "query", "description": "The ID of the fulfillment that's associated with the fulfillment event." }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that's associated with the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/orders/:order_id/fulfillments/:fulfillment_id/events.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "fulfillment_id", "value": "", "type": "query", "description": "The ID of the fulfillment that's associated with the fulfillment event." }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that's associated with the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/orders/:order_id/fulfillments/:fulfillment_id/events.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "fulfillment_id", "value": "", "type": "query", "description": "The ID of the fulfillment that's associated with the fulfillment event." }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that's associated with the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/orders/:order_id/fulfillments/:fulfillment_id/events.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "fulfillment_id", "value": "", "type": "query", "description": "The ID of the fulfillment that's associated with the fulfillment event." }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that's associated with the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/orders/:order_id/fulfillments/:fulfillment_id/events.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "fulfillment_id", "value": "", "type": "query", "description": "The ID of the fulfillment that's associated with the fulfillment event." }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that's associated with the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/orders/:order_id/fulfillment_orders.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that is associated with the fulfillment orders." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/orders/:order_id/fulfillment_orders.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that is associated with the fulfillment orders." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/orders/:order_id/fulfillment_orders.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that is associated with the fulfillment orders." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/orders/:order_id/fulfillment_orders.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that is associated with the fulfillment orders." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/orders/:order_id/fulfillment_orders.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that is associated with the fulfillment orders." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/orders/:order_id/fulfillment_orders.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that is associated with the fulfillment orders." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/locations_for_move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "fulfillment_order_id", "value": "", "type": "query", "description": "The ID of the fulfillment order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/locations_for_move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "fulfillment_order_id", "value": "", "type": "query", "description": "The ID of the fulfillment order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/locations_for_move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "fulfillment_order_id", "value": "", "type": "query", "description": "The ID of the fulfillment order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/locations_for_move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "fulfillment_order_id", "value": "", "type": "query", "description": "The ID of the fulfillment order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/locations_for_move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "fulfillment_order_id", "value": "", "type": "query", "description": "The ID of the fulfillment order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/locations_for_move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "fulfillment_order_id", "value": "", "type": "query", "description": "The ID of the fulfillment order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of All Payouts Ordered By Payout Date", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/shopify_payments/payouts.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Filter the response to payouts made after the specified ID." }, { "name": "last_id", "value": "", "type": "query", "description": "Filter the response to payouts made before the specified ID." }, { "name": "date_min", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively after the specified date." }, { "name": "date_max", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively before the specified date." }, { "name": "date", "value": "", "type": "query", "description": "Filter the response to payouts made on the specified date." }, { "name": "status", "value": "", "type": "query", "description": "Filter the response to payouts made with the specified status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of All Payouts Ordered By Payout Date", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/shopify_payments/payouts.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Filter the response to payouts made after the specified ID." }, { "name": "last_id", "value": "", "type": "query", "description": "Filter the response to payouts made before the specified ID." }, { "name": "date_min", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively after the specified date." }, { "name": "date_max", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively before the specified date." }, { "name": "date", "value": "", "type": "query", "description": "Filter the response to payouts made on the specified date." }, { "name": "status", "value": "", "type": "query", "description": "Filter the response to payouts made with the specified status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of All Payouts Ordered By Payout Date", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/shopify_payments/payouts.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Filter the response to payouts made after the specified ID." }, { "name": "last_id", "value": "", "type": "query", "description": "Filter the response to payouts made before the specified ID." }, { "name": "date_min", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively after the specified date." }, { "name": "date_max", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively before the specified date." }, { "name": "date", "value": "", "type": "query", "description": "Filter the response to payouts made on the specified date." }, { "name": "status", "value": "", "type": "query", "description": "Filter the response to payouts made with the specified status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of All Payouts Ordered By Payout Date", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/shopify_payments/payouts.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Filter the response to payouts made after the specified ID." }, { "name": "last_id", "value": "", "type": "query", "description": "Filter the response to payouts made before the specified ID." }, { "name": "date_min", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively after the specified date." }, { "name": "date_max", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively before the specified date." }, { "name": "date", "value": "", "type": "query", "description": "Filter the response to payouts made on the specified date." }, { "name": "status", "value": "", "type": "query", "description": "Filter the response to payouts made with the specified status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of All Payouts Ordered By Payout Date", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/shopify_payments/payouts.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Filter the response to payouts made after the specified ID." }, { "name": "last_id", "value": "", "type": "query", "description": "Filter the response to payouts made before the specified ID." }, { "name": "date_min", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively after the specified date." }, { "name": "date_max", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively before the specified date." }, { "name": "date", "value": "", "type": "query", "description": "Filter the response to payouts made on the specified date." }, { "name": "status", "value": "", "type": "query", "description": "Filter the response to payouts made with the specified status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of All Payouts Ordered By Payout Date", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/shopify_payments/payouts.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Filter the response to payouts made after the specified ID." }, { "name": "last_id", "value": "", "type": "query", "description": "Filter the response to payouts made before the specified ID." }, { "name": "date_min", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively after the specified date." }, { "name": "date_max", "value": "", "type": "query", "description": "Filter the response to payouts made inclusively before the specified date." }, { "name": "date", "value": "", "type": "query", "description": "Filter the response to payouts made on the specified date." }, { "name": "status", "value": "", "type": "query", "description": "Filter the response to payouts made with the specified status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of All Balance Transactions Ordered By Processingtime", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/shopify_payments/balance/transactions.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Filter response to transactions exclusively after the specified ID." }, { "name": "last_id", "value": "", "type": "query", "description": "Filter response to transactions exclusively before the specified ID" }, { "name": "test", "value": "", "type": "query", "description": "Filter response to transactions placed in test mode." }, { "name": "payout_id", "value": "", "type": "query", "description": "Filter response to transactions paid out in the specified payout." }, { "name": "payout_status", "value": "", "type": "query", "description": "Filter response to transactions with the specified payout status" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/transaction#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Countries", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/countries.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Countries", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/countries.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Countries", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/countries.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Countries", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/countries.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Countries", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/countries.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Countries", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/countries.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Currencies Enabled On A Shop", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/currencies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Currencies Enabled On A Shop", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/currencies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Currencies Enabled On A Shop", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/currencies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Currencies Enabled On A Shop", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/currencies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Currencies Enabled On A Shop", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/currencies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Currencies Enabled On A Shop", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/currencies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of The Shop's Policies", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/policies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of The Shop's Policies", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/policies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of The Shop's Policies", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/policies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of The Shop's Policies", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/policies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of The Shop's Policies", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/policies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of The Shop's Policies", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/policies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Provinces", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/countries/:country_id/provinces.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of fields names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Provinces", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/countries/:country_id/provinces.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of fields names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Provinces", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/countries/:country_id/provinces.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of fields names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Provinces", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/countries/:country_id/provinces.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of fields names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Provinces", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/countries/:country_id/provinces.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of fields names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Provinces", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/countries/:country_id/provinces.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of fields names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-unstable" }, { "info": { "name": "Shopify Get A List Of All Shipping Zones", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/shipping_zones.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-01" }, { "info": { "name": "Shopify Get A List Of All Shipping Zones", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/shipping_zones.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-04" }, { "info": { "name": "Shopify Get A List Of All Shipping Zones", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/shipping_zones.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-07" }, { "info": { "name": "Shopify Get A List Of All Shipping Zones", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/shipping_zones.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-10" }, { "info": { "name": "Shopify Get A List Of All Shipping Zones", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/shipping_zones.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2021-01" }, { "info": { "name": "Shopify Get A List Of All Shipping Zones", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/shipping_zones.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Tender Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/tender_transactions.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Retrieve only transactions after the specified ID." }, { "name": "processed_at_min", "value": "", "type": "query", "description": "Show tender transactions processed_at or after the specified date." }, { "name": "processed_at_max", "value": "", "type": "query", "description": "Show tender transactions processed_at or before the specified date." }, { "name": "processed_at", "value": "", "type": "query", "description": "Show tender transactions processed at the specified date." }, { "name": "order", "value": "", "type": "query", "description": "Show tender transactions ordered by processed_at in ascending or descending order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Tender Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/tender_transactions.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Retrieve only transactions after the specified ID." }, { "name": "processed_at_min", "value": "", "type": "query", "description": "Show tender transactions processed_at or after the specified date." }, { "name": "processed_at_max", "value": "", "type": "query", "description": "Show tender transactions processed_at or before the specified date." }, { "name": "processed_at", "value": "", "type": "query", "description": "Show tender transactions processed at the specified date." }, { "name": "order", "value": "", "type": "query", "description": "Show tender transactions ordered by processed_at in ascending or descending order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Tender Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/tender_transactions.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Retrieve only transactions after the specified ID." }, { "name": "processed_at_min", "value": "", "type": "query", "description": "Show tender transactions processed_at or after the specified date." }, { "name": "processed_at_max", "value": "", "type": "query", "description": "Show tender transactions processed_at or before the specified date." }, { "name": "processed_at", "value": "", "type": "query", "description": "Show tender transactions processed at the specified date." }, { "name": "order", "value": "", "type": "query", "description": "Show tender transactions ordered by processed_at in ascending or descending order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Tender Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/tender_transactions.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Retrieve only transactions after the specified ID." }, { "name": "processed_at_min", "value": "", "type": "query", "description": "Show tender transactions processed_at or after the specified date." }, { "name": "processed_at_max", "value": "", "type": "query", "description": "Show tender transactions processed_at or before the specified date." }, { "name": "processed_at", "value": "", "type": "query", "description": "Show tender transactions processed at the specified date." }, { "name": "order", "value": "", "type": "query", "description": "Show tender transactions ordered by processed_at in ascending or descending order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Tender Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/tender_transactions.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Retrieve only transactions after the specified ID." }, { "name": "processed_at_min", "value": "", "type": "query", "description": "Show tender transactions processed_at or after the specified date." }, { "name": "processed_at_max", "value": "", "type": "query", "description": "Show tender transactions processed_at or before the specified date." }, { "name": "processed_at", "value": "", "type": "query", "description": "Show tender transactions processed at the specified date." }, { "name": "order", "value": "", "type": "query", "description": "Show tender transactions ordered by processed_at in ascending or descending order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Tender Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/tender_transactions.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Retrieve only transactions after the specified ID." }, { "name": "processed_at_min", "value": "", "type": "query", "description": "Show tender transactions processed_at or after the specified date." }, { "name": "processed_at_max", "value": "", "type": "query", "description": "Show tender transactions processed_at or before the specified date." }, { "name": "processed_at", "value": "", "type": "query", "description": "Show tender transactions processed at the specified date." }, { "name": "order", "value": "", "type": "query", "description": "Show tender transactions ordered by processed_at in ascending or descending order." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-unstable" } ] } ], "bundled": true }