{ "opencollection": "1.0.0", "info": { "name": "Shopify API", "version": "2020-10" }, "items": [ { "info": { "name": "Access", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Access Scopes Associated To The Access Token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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 Creates A New Storefront Access Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/storefront_access_tokens.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2020-01" }, { "info": { "name": "Shopify Deletes An Existing Storefront Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/storefront_access_tokens/:storefront_access_token_id.json", "params": [ { "name": "storefront_access_token_id", "value": "", "type": "path", "description": "storefront_access_token_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A New Storefront Access Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/storefront_access_tokens.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2020-04" }, { "info": { "name": "Shopify Deletes An Existing Storefront Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/storefront_access_tokens/:storefront_access_token_id.json", "params": [ { "name": "storefront_access_token_id", "value": "", "type": "path", "description": "storefront_access_token_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A New Storefront Access Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/storefront_access_tokens.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2020-07" }, { "info": { "name": "Shopify Deletes An Existing Storefront Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/storefront_access_tokens/:storefront_access_token_id.json", "params": [ { "name": "storefront_access_token_id", "value": "", "type": "path", "description": "storefront_access_token_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A New Storefront Access Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/storefront_access_tokens.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2020-10" }, { "info": { "name": "Shopify Deletes An Existing Storefront Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/storefront_access_tokens/:storefront_access_token_id.json", "params": [ { "name": "storefront_access_token_id", "value": "", "type": "path", "description": "storefront_access_token_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A New Storefront Access Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/storefront_access_tokens.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2021-01" }, { "info": { "name": "Shopify Deletes An Existing Storefront Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/storefront_access_tokens/:storefront_access_token_id.json", "params": [ { "name": "storefront_access_token_id", "value": "", "type": "path", "description": "storefront_access_token_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Storefront Access Tokens That Have Been Issued", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/storefront_access_tokens.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-unstable" }, { "info": { "name": "Shopify Creates A New Storefront Access Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/storefront_access_tokens.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-unstable" }, { "info": { "name": "Shopify Deletes An Existing Storefront Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/storefront_access_tokens/:storefront_access_token_id.json", "params": [ { "name": "storefront_access_token_id", "value": "", "type": "path", "description": "storefront_access_token_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-unstable" } ] }, { "info": { "name": "Lists", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Webhooks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Themes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Refunds For An Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Collects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Retrieves A List Of Products", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 The Shop's Policies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Retrieves A List Of Tender Transactions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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" } ] }, { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A New Report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/reports.json", "params": [ { "name": "name", "value": "", "type": "query", "description": "The name of the report. Maximum length: 255 characters." }, { "name": "shopify_ql", "value": "", "type": "query", "description": "The ShopifyQL the report will query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-2020-01" }, { "info": { "name": "Shopify Updates A Report", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-2020-01" }, { "info": { "name": "Shopify Deletes A Report", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#destroy-2020-01" }, { "info": { "name": "Shopify Creates A New Report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/reports.json", "params": [ { "name": "name", "value": "", "type": "query", "description": "The name of the report. Maximum length: 255 characters." }, { "name": "shopify_ql", "value": "", "type": "query", "description": "The ShopifyQL the report will query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-2020-04" }, { "info": { "name": "Shopify Updates A Report", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-2020-04" }, { "info": { "name": "Shopify Deletes A Report", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#destroy-2020-04" }, { "info": { "name": "Shopify Creates A New Report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/reports.json", "params": [ { "name": "name", "value": "", "type": "query", "description": "The name of the report. Maximum length: 255 characters." }, { "name": "shopify_ql", "value": "", "type": "query", "description": "The ShopifyQL the report will query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-2020-07" }, { "info": { "name": "Shopify Updates A Report", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-2020-07" }, { "info": { "name": "Shopify Deletes A Report", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#destroy-2020-07" }, { "info": { "name": "Shopify Creates A New Report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/reports.json", "params": [ { "name": "name", "value": "", "type": "query", "description": "The name of the report. Maximum length: 255 characters." }, { "name": "shopify_ql", "value": "", "type": "query", "description": "The ShopifyQL the report will query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-2020-10" }, { "info": { "name": "Shopify Updates A Report", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-2020-10" }, { "info": { "name": "Shopify Deletes A Report", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#destroy-2020-10" }, { "info": { "name": "Shopify Creates A New Report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/reports.json", "params": [ { "name": "name", "value": "", "type": "query", "description": "The name of the report. Maximum length: 255 characters." }, { "name": "shopify_ql", "value": "", "type": "query", "description": "The ShopifyQL the report will query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-2021-01" }, { "info": { "name": "Shopify Updates A Report", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-2021-01" }, { "info": { "name": "Shopify Deletes A Report", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#destroy-2021-01" }, { "info": { "name": "Shopify Creates A New Report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/reports.json", "params": [ { "name": "name", "value": "", "type": "query", "description": "The name of the report. Maximum length: 255 characters." }, { "name": "shopify_ql", "value": "", "type": "query", "description": "The ShopifyQL the report will query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-unstable" }, { "info": { "name": "Shopify Updates A Report", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-unstable" }, { "info": { "name": "Shopify Deletes A Report", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#destroy-unstable" } ] }, { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Report Created By Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/reports/:report_id.json", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "report_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-01" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-01" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-04" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-04" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-07" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-07" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-10" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-10" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2021-01" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2021-01" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-unstable" }, { "info": { "name": "Shopify Creates An Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-unstable" }, { "info": { "name": "Shopify Retrieves An Application Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/application_charges/:application_charge_id.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-unstable" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-01" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-04" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-07" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-10" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2021-01" }, { "info": { "name": "Shopify Creates An Application Credit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/application_credits.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Application Credit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/application_credits/:application_credit_id.json", "params": [ { "name": "application_credit_id", "value": "", "type": "path", "description": "application_credit_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-01" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2020-01" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-04" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2020-04" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-07" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2020-07" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-10" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2020-10" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2021-01" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2021-01" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Recurring Application Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/recurring_application_charges.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-unstable" }, { "info": { "name": "Shopify Creates A Recurring Application Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/recurring_application_charges.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-unstable" }, { "info": { "name": "Shopify Cancels A Recurring Application Charge", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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 Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-01" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-01" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-01" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-01" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-04" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-04" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-04" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-04" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-07" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-07" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-07" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-07" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-10" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-10" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-10" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-10" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2021-01" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2021-01" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2021-01" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2021-01" }, { "info": { "name": "Shopify Retrieve Collection Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/collection_listings.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-unstable" }, { "info": { "name": "Shopify Retrieve A Specific Collection Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-unstable" }, { "info": { "name": "Shopify Create A Collection Listing To Publish A Collection To Your App", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-unstable" }, { "info": { "name": "Shopify Delete A Collection Listing To Unpublish A Collection From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/collection_listings/:collection_listing_id.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-unstable" }, { "info": { "name": "Shopify Retrieve Product Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/product_listings.json", "params": [ { "name": "product_ids", "value": "", "type": "query", "description": "A comma-separated list of product ids" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter by products belonging to a particular collection" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Filter by products last updated after a certain date and time (formatted in ISO 8601)" }, { "name": "handle", "value": "", "type": "query", "description": "Filter by product handle" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-01" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/product_listings/product_ids.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#product_ids-2020-01" }, { "info": { "name": "Shopify Retrieve A Count Of Products That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/product_listings/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#count-2020-01" }, { "info": { "name": "Shopify Retrieve A Specific Product Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-01" }, { "info": { "name": "Shopify Create A Product Listing To Publish A Product To Your App", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-01" }, { "info": { "name": "Shopify Delete A Product Listing To Unpublish A Product From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-01" }, { "info": { "name": "Shopify Retrieve Product Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/product_listings.json", "params": [ { "name": "product_ids", "value": "", "type": "query", "description": "A comma-separated list of product ids" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter by products belonging to a particular collection" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Filter by products last updated after a certain date and time (formatted in ISO 8601)" }, { "name": "handle", "value": "", "type": "query", "description": "Filter by product handle" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-04" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/product_listings/product_ids.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#product_ids-2020-04" }, { "info": { "name": "Shopify Retrieve A Count Of Products That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/product_listings/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#count-2020-04" }, { "info": { "name": "Shopify Retrieve A Specific Product Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-04" }, { "info": { "name": "Shopify Create A Product Listing To Publish A Product To Your App", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-04" }, { "info": { "name": "Shopify Delete A Product Listing To Unpublish A Product From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-04" }, { "info": { "name": "Shopify Retrieve Product Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/product_listings.json", "params": [ { "name": "product_ids", "value": "", "type": "query", "description": "A comma-separated list of product ids" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter by products belonging to a particular collection" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Filter by products last updated after a certain date and time (formatted in ISO 8601)" }, { "name": "handle", "value": "", "type": "query", "description": "Filter by product handle" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-07" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/product_listings/product_ids.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#product_ids-2020-07" }, { "info": { "name": "Shopify Retrieve A Count Of Products That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/product_listings/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#count-2020-07" }, { "info": { "name": "Shopify Retrieve A Specific Product Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-07" }, { "info": { "name": "Shopify Create A Product Listing To Publish A Product To Your App", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-07" }, { "info": { "name": "Shopify Delete A Product Listing To Unpublish A Product From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "Endpoint", "type": "folder" }, "items": [ { "info": { "name": "Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version 2021-01", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/application_charges/:application_charge_id/activate.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#activate-2020-01" }, { "info": { "name": "Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version 2021-01", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/application_charges/:application_charge_id/activate.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#activate-2020-04" }, { "info": { "name": "Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version 2021-01", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/application_charges/:application_charge_id/activate.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#activate-2020-07" }, { "info": { "name": "Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version 2021-01", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/application_charges/:application_charge_id/activate.json", "params": [ { "name": "application_charge_id", "value": "", "type": "path", "description": "application_charge_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#activate-2020-10" }, { "info": { "name": "Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version 2021-01", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/recurring_application_charges/:recurring_application_charge_id/activate.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#activate-2020-01" }, { "info": { "name": "Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version 2021-01", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/recurring_application_charges/:recurring_application_charge_id/activate.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#activate-2020-04" }, { "info": { "name": "Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version 2021-01", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/recurring_application_charges/:recurring_application_charge_id/activate.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#activate-2020-07" }, { "info": { "name": "Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version 2021-01", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/recurring_application_charges/:recurring_application_charge_id/activate.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#activate-2020-10" } ] }, { "info": { "name": "All", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-01" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-04" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-07" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-10" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2021-01" }, { "info": { "name": "Shopify Retrieves All Application Credits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/application_credits.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2020-01" }, { "info": { "name": "Shopify Retrieves All Orders Belonging To A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/customers/:customer_id/orders.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#orders-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2020-04" }, { "info": { "name": "Shopify Retrieves All Orders Belonging To A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/customers/:customer_id/orders.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#orders-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2020-07" }, { "info": { "name": "Shopify Retrieves All Orders Belonging To A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/customers/:customer_id/orders.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#orders-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2020-10" }, { "info": { "name": "Shopify Retrieves All Orders Belonging To A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/customers/:customer_id/orders.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#orders-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2021-01" }, { "info": { "name": "Shopify Retrieves All Orders Belonging To A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/customers/:customer_id/orders.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#orders-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-unstable" }, { "info": { "name": "Shopify Retrieves All Orders Belonging To A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/customers/:customer_id/orders.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#orders-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-01" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "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/customersavedsearch#other-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-04" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "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/customersavedsearch#other-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-07" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "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/customersavedsearch#other-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-10" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "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/customersavedsearch#other-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2021-01" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "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/customersavedsearch#other-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-unstable" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "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/customersavedsearch#other-unstable" }, { "info": { "name": "Shopify Retrieves A List Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/blogs/:blog_id/articles/count.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count articles with a given published status.\n (default: any)\n \n published: Count only published articles.\n unpublished: Count only unpublished articles.\n any: Count all articles." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2020-01" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Count Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/blogs/:blog_id/articles/count.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count articles with a given published status.\n (default: any)\n \n published: Count only published articles.\n unpublished: Count only unpublished articles.\n any: Count all articles." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2020-04" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Count Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/blogs/:blog_id/articles/count.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count articles with a given published status.\n (default: any)\n \n published: Count only published articles.\n unpublished: Count only unpublished articles.\n any: Count all articles." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2020-07" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Count Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/blogs/:blog_id/articles/count.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count articles with a given published status.\n (default: any)\n \n published: Count only published articles.\n unpublished: Count only unpublished articles.\n any: Count all articles." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2020-10" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Count Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/blogs/:blog_id/articles/count.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count articles with a given published status.\n (default: any)\n \n published: Count only published articles.\n unpublished: Count only unpublished articles.\n any: Count all articles." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2021-01" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Count Of All Articles From A Blog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/blogs/:blog_id/articles/count.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count articles created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count articles created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count articles last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count articles last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count articles published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count articles published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count articles with a given published status.\n (default: any)\n \n published: Count only published articles.\n unpublished: Count only unpublished articles.\n any: Count all articles." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-unstable" }, { "info": { "name": "Shopify Retrieves A List All Of Article Authors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Get A Count Of All Blogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/blogs/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#count-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/script_tags/count.json", "params": [ { "name": "src", "value": "", "type": "query", "description": "Count only script tags with a given URL." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/script_tags/count.json", "params": [ { "name": "src", "value": "", "type": "query", "description": "Count only script tags with a given URL." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/script_tags/count.json", "params": [ { "name": "src", "value": "", "type": "query", "description": "Count only script tags with a given URL." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/script_tags/count.json", "params": [ { "name": "src", "value": "", "type": "query", "description": "Count only script tags with a given URL." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/script_tags/count.json", "params": [ { "name": "src", "value": "", "type": "query", "description": "Count only script tags with a given URL." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of All Script Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/script_tags/count.json", "params": [ { "name": "src", "value": "", "type": "query", "description": "Count only script tags with a given URL." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-unstable" }, { "info": { "name": "Shopify Retrieves A List Of All Order Risks For An Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 All Users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "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/products/product-image#index-2020-01" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-01" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "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/products/product-image#index-2020-04" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-04" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "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/products/product-image#index-2020-07" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-07" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "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/products/product-image#index-2020-10" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-10" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "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/products/product-image#index-2021-01" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2021-01" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "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/products/product-image#index-unstable" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-unstable" }, { "info": { "name": "Shopify Retrieve All Disputes Ordered By Initiated_at Date And Time (iso 8601 Format)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/shopify_payments/disputes.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Return only disputes after the specified ID." }, { "name": "last_id", "value": "", "type": "query", "description": "Return only disputes before the specified ID." }, { "name": "status", "value": "", "type": "query", "description": "Return only disputes with the specified status." }, { "name": "initiated_at", "value": "", "type": "query", "description": "Return only disputes with the specified initiated_at date (ISO 8601 format)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/dispute#index-2020-01" }, { "info": { "name": "Shopify Retrieve All Disputes Ordered By Initiated_at Date And Time (iso 8601 Format)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/shopify_payments/disputes.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Return only disputes after the specified ID." }, { "name": "last_id", "value": "", "type": "query", "description": "Return only disputes before the specified ID." }, { "name": "status", "value": "", "type": "query", "description": "Return only disputes with the specified status." }, { "name": "initiated_at", "value": "", "type": "query", "description": "Return only disputes with the specified initiated_at date (ISO 8601 format)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/dispute#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of All Payouts Ordered By Payout Date", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Get A List Of All Shipping Zones", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "Charge", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "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#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "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#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "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#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "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#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "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#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/recurring_application_charges/:recurring_application_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "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#show-unstable" }, { "info": { "name": "Shopify Creates A Usage Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/recurring_application_charges/:recurring_application_charge_id/usage_charges/:usage_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "usage_charge_id", "value": "", "type": "path", "description": "usage_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#show-2020-01" }, { "info": { "name": "Shopify Creates A Usage Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/recurring_application_charges/:recurring_application_charge_id/usage_charges/:usage_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "usage_charge_id", "value": "", "type": "path", "description": "usage_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#show-2020-04" }, { "info": { "name": "Shopify Creates A Usage Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/recurring_application_charges/:recurring_application_charge_id/usage_charges/:usage_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "usage_charge_id", "value": "", "type": "path", "description": "usage_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#show-2020-07" }, { "info": { "name": "Shopify Creates A Usage Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/recurring_application_charges/:recurring_application_charge_id/usage_charges/:usage_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "usage_charge_id", "value": "", "type": "path", "description": "usage_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#show-2020-10" }, { "info": { "name": "Shopify Creates A Usage Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/recurring_application_charges/:recurring_application_charge_id/usage_charges/:usage_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "usage_charge_id", "value": "", "type": "path", "description": "usage_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#show-2021-01" }, { "info": { "name": "Shopify Creates A Usage Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Charge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/recurring_application_charges/:recurring_application_charge_id/usage_charges/:usage_charge_id.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "usage_charge_id", "value": "", "type": "path", "description": "usage_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#show-unstable" } ] }, { "info": { "name": "Active", "type": "folder" }, "items": [ { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2020-01" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2020-04" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2020-07" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2020-10" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2021-01" }, { "info": { "name": "Shopify Updates The Capped Amount Of An Active Recurring Application Charge", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/recurring_application_charges/:recurring_application_charge_id/customize.json", "params": [ { "name": "recurring_application_charge_id", "value": "", "type": "path", "description": "recurring_application_charge_id" }, { "name": "recurring_application_charge[capped_amount]", "value": "", "type": "query", "description": "recurring_application_charge[capped_amount]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-unstable" } ] }, { "info": { "name": "Charges", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Usage Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "Customers", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "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#search-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "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#search-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "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#search-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "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#search-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "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#search-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "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#search-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_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#show-2020-01" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2020-01" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_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#show-2020-04" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2020-04" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_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#show-2020-07" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2020-07" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_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#show-2020-10" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2020-10" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_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#show-2021-01" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2021-01" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_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#show-unstable" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-unstable" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-unstable" } ] }, { "info": { "name": "Customer", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/customers.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_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/customer#show-2020-01" }, { "info": { "name": "Shopify Updates A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#update-2020-01" }, { "info": { "name": "Shopify Deletes A Customer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#destroy-2020-01" }, { "info": { "name": "Shopify Creates A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/customers.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_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/customer#show-2020-04" }, { "info": { "name": "Shopify Updates A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#update-2020-04" }, { "info": { "name": "Shopify Deletes A Customer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#destroy-2020-04" }, { "info": { "name": "Shopify Creates A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/customers.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_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/customer#show-2020-07" }, { "info": { "name": "Shopify Updates A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#update-2020-07" }, { "info": { "name": "Shopify Deletes A Customer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#destroy-2020-07" }, { "info": { "name": "Shopify Creates A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/customers.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_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/customer#show-2020-10" }, { "info": { "name": "Shopify Updates A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#update-2020-10" }, { "info": { "name": "Shopify Deletes A Customer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#destroy-2020-10" }, { "info": { "name": "Shopify Creates A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/customers.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_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/customer#show-2021-01" }, { "info": { "name": "Shopify Updates A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#update-2021-01" }, { "info": { "name": "Shopify Deletes A Customer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#destroy-2021-01" }, { "info": { "name": "Shopify Creates A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/customers.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_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/customer#show-unstable" }, { "info": { "name": "Shopify Updates A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#update-unstable" }, { "info": { "name": "Shopify Deletes A Customer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#destroy-unstable" } ] }, { "info": { "name": "Account", "type": "folder" }, "items": [ { "info": { "name": "Shopify Generate An Account Activation Url For A Customer Whose Account Is Not Yet Enabled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/customers/:customer_id/account_activation_url.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2020-01" }, { "info": { "name": "Shopify Sends An Account Invite To A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/customers/:customer_id/send_invite.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2020-01" }, { "info": { "name": "Shopify Generate An Account Activation Url For A Customer Whose Account Is Not Yet Enabled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/customers/:customer_id/account_activation_url.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2020-04" }, { "info": { "name": "Shopify Sends An Account Invite To A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/customers/:customer_id/send_invite.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2020-04" }, { "info": { "name": "Shopify Generate An Account Activation Url For A Customer Whose Account Is Not Yet Enabled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/customers/:customer_id/account_activation_url.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2020-07" }, { "info": { "name": "Shopify Sends An Account Invite To A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/customers/:customer_id/send_invite.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2020-07" }, { "info": { "name": "Shopify Generate An Account Activation Url For A Customer Whose Account Is Not Yet Enabled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/customers/:customer_id/account_activation_url.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2020-10" }, { "info": { "name": "Shopify Sends An Account Invite To A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/customers/:customer_id/send_invite.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2020-10" }, { "info": { "name": "Shopify Generate An Account Activation Url For A Customer Whose Account Is Not Yet Enabled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/customers/:customer_id/account_activation_url.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2021-01" }, { "info": { "name": "Shopify Sends An Account Invite To A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/customers/:customer_id/send_invite.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2021-01" }, { "info": { "name": "Shopify Generate An Account Activation Url For A Customer Whose Account Is Not Yet Enabled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/customers/:customer_id/account_activation_url.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-unstable" }, { "info": { "name": "Shopify Sends An Account Invite To A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/customers/:customer_id/send_invite.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-unstable" } ] }, { "info": { "name": "Addresses", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-unstable" } ] }, { "info": { "name": "Address", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2020-01" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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#show-2020-01" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2020-01" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/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 Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/customers/:customer_id/addresses/:address_id/default.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#default-2020-01" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2020-04" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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#show-2020-04" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2020-04" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/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 Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/customers/:customer_id/addresses/:address_id/default.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#default-2020-04" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2020-07" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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#show-2020-07" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2020-07" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/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 Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/customers/:customer_id/addresses/:address_id/default.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#default-2020-07" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2020-10" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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#show-2020-10" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2020-10" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/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 Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/customers/:customer_id/addresses/:address_id/default.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#default-2020-10" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2021-01" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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#show-2021-01" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2021-01" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/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 Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/customers/:customer_id/addresses/:address_id/default.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#default-2021-01" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-unstable" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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#show-unstable" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-unstable" }, { "info": { "name": "Shopify Removes An Address From A Customer’s Address List", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/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 Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/customers/:customer_id/addresses/:address_id/default.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#default-unstable" }, { "info": { "name": "Shopify Create A New Webhook Subscription By Specifying Both An Address And A Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/webhooks.json", "params": [ { "name": "format", "value": "", "type": "query", "description": "Use this parameter to select the data format for the payload. Valid values are json and xml.\n (default: json)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-2020-01" }, { "info": { "name": "Shopify Update A Webhook Subscription's Topic Or Address Uris", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-01" }, { "info": { "name": "Shopify Create A New Webhook Subscription By Specifying Both An Address And A Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/webhooks.json", "params": [ { "name": "format", "value": "", "type": "query", "description": "Use this parameter to select the data format for the payload. Valid values are json and xml.\n (default: json)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-2020-04" }, { "info": { "name": "Shopify Update A Webhook Subscription's Topic Or Address Uris", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-04" }, { "info": { "name": "Shopify Create A New Webhook Subscription By Specifying Both An Address And A Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/webhooks.json", "params": [ { "name": "format", "value": "", "type": "query", "description": "Use this parameter to select the data format for the payload. Valid values are json and xml.\n (default: json)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-2020-07" }, { "info": { "name": "Shopify Update A Webhook Subscription's Topic Or Address Uris", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-07" }, { "info": { "name": "Shopify Create A New Webhook Subscription By Specifying Both An Address And A Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/webhooks.json", "params": [ { "name": "format", "value": "", "type": "query", "description": "Use this parameter to select the data format for the payload. Valid values are json and xml.\n (default: json)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-2020-10" }, { "info": { "name": "Shopify Update A Webhook Subscription's Topic Or Address Uris", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-10" }, { "info": { "name": "Shopify Create A New Webhook Subscription By Specifying Both An Address And A Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/webhooks.json", "params": [ { "name": "format", "value": "", "type": "query", "description": "Use this parameter to select the data format for the payload. Valid values are json and xml.\n (default: json)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-2021-01" }, { "info": { "name": "Shopify Update A Webhook Subscription's Topic Or Address Uris", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2021-01" }, { "info": { "name": "Shopify Create A New Webhook Subscription By Specifying Both An Address And A Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/webhooks.json", "params": [ { "name": "format", "value": "", "type": "query", "description": "Use this parameter to select the data format for the payload. Valid values are json and xml.\n (default: json)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-unstable" }, { "info": { "name": "Shopify Update A Webhook Subscription's Topic Or Address Uris", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-unstable" } ] }, { "info": { "name": "Discount", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Retrieve A List Of Discount Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "Code", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A Discount Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2020-01" }, { "info": { "name": "Shopify Updates An Existing Discount Code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#update-2020-01" }, { "info": { "name": "Shopify Deletes A Discount Code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#destroy-2020-01" }, { "info": { "name": "Shopify Retrieves The Location Of A Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/discount_codes/lookup.json", "params": [ { "name": "code", "value": "", "type": "query", "description": "code" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2020-01" }, { "info": { "name": "Shopify Creates A Discount Code Creation Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/price_rules/:price_rule_id/batch.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-01" }, { "info": { "name": "Shopify Retrieves A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/price_rules/:price_rule_id/batch/:batch_id.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_show-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Discount Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2020-04" }, { "info": { "name": "Shopify Updates An Existing Discount Code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#update-2020-04" }, { "info": { "name": "Shopify Deletes A Discount Code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#destroy-2020-04" }, { "info": { "name": "Shopify Retrieves The Location Of A Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/discount_codes/lookup.json", "params": [ { "name": "code", "value": "", "type": "query", "description": "code" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2020-04" }, { "info": { "name": "Shopify Creates A Discount Code Creation Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/price_rules/:price_rule_id/batch.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-04" }, { "info": { "name": "Shopify Retrieves A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/price_rules/:price_rule_id/batch/:batch_id.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_show-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Discount Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2020-07" }, { "info": { "name": "Shopify Updates An Existing Discount Code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#update-2020-07" }, { "info": { "name": "Shopify Deletes A Discount Code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves The Location Of A Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/discount_codes/lookup.json", "params": [ { "name": "code", "value": "", "type": "query", "description": "code" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2020-07" }, { "info": { "name": "Shopify Creates A Discount Code Creation Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/price_rules/:price_rule_id/batch.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-07" }, { "info": { "name": "Shopify Retrieves A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/price_rules/:price_rule_id/batch/:batch_id.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_show-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Discount Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2020-10" }, { "info": { "name": "Shopify Updates An Existing Discount Code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#update-2020-10" }, { "info": { "name": "Shopify Deletes A Discount Code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#destroy-2020-10" }, { "info": { "name": "Shopify Retrieves The Location Of A Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/discount_codes/lookup.json", "params": [ { "name": "code", "value": "", "type": "query", "description": "code" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2020-10" }, { "info": { "name": "Shopify Creates A Discount Code Creation Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/price_rules/:price_rule_id/batch.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-10" }, { "info": { "name": "Shopify Retrieves A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/price_rules/:price_rule_id/batch/:batch_id.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_show-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Discount Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2021-01" }, { "info": { "name": "Shopify Updates An Existing Discount Code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#update-2021-01" }, { "info": { "name": "Shopify Deletes A Discount Code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#destroy-2021-01" }, { "info": { "name": "Shopify Retrieves The Location Of A Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/discount_codes/lookup.json", "params": [ { "name": "code", "value": "", "type": "query", "description": "code" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2021-01" }, { "info": { "name": "Shopify Creates A Discount Code Creation Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/price_rules/:price_rule_id/batch.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2021-01" }, { "info": { "name": "Shopify Retrieves A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/price_rules/:price_rule_id/batch/:batch_id.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_show-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Discount Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/price_rules/:price_rule_id/discount_codes.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-unstable" }, { "info": { "name": "Shopify Updates An Existing Discount Code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#update-unstable" }, { "info": { "name": "Shopify Deletes A Discount Code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/price_rules/:price_rule_id/discount_codes/:discount_code_id.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" }, { "name": "discount_code_id", "value": "", "type": "path", "description": "discount_code_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#destroy-unstable" }, { "info": { "name": "Shopify Retrieves The Location Of A Discount Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/discount_codes/lookup.json", "params": [ { "name": "code", "value": "", "type": "query", "description": "code" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-unstable" }, { "info": { "name": "Shopify Creates A Discount Code Creation Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/price_rules/:price_rule_id/batch.json", "params": [ { "name": "price_rule_id", "value": "", "type": "path", "description": "price_rule_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-unstable" }, { "info": { "name": "Shopify Retrieves A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/price_rules/:price_rule_id/batch/:batch_id.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_show-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "Events", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_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/events/event#show-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_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/events/event#show-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_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/events/event#show-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_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/events/event#show-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_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/events/event#show-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_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/events/event#show-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Fulfillment Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Specific Fulfillment Event", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "event_id", "value": "", "type": "query", "description": "The ID of the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Fulfillment Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Specific Fulfillment Event", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "event_id", "value": "", "type": "query", "description": "The ID of the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Fulfillment Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Specific Fulfillment Event", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "event_id", "value": "", "type": "query", "description": "The ID of the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Fulfillment Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Specific Fulfillment Event", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "event_id", "value": "", "type": "query", "description": "The ID of the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Fulfillment Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Specific Fulfillment Event", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "event_id", "value": "", "type": "query", "description": "The ID of the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Fulfillment Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#create-unstable" }, { "info": { "name": "Shopify Retrieves A Specific Fulfillment Event", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "event_id", "value": "", "type": "query", "description": "The ID of the fulfillment event." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-unstable" } ] }, { "info": { "name": "Count", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Count Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/events/count.json", "params": [ { "name": "created_at_min", "value": "", "type": "query", "description": "Count only 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": "Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/events/count.json", "params": [ { "name": "created_at_min", "value": "", "type": "query", "description": "Count only 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": "Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/events/count.json", "params": [ { "name": "created_at_min", "value": "", "type": "query", "description": "Count only 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": "Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/events/count.json", "params": [ { "name": "created_at_min", "value": "", "type": "query", "description": "Count only 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": "Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/events/count.json", "params": [ { "name": "created_at_min", "value": "", "type": "query", "description": "Count only 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": "Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/events/count.json", "params": [ { "name": "created_at_min", "value": "", "type": "query", "description": "Count only 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": "Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#count-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of Existing Webhook Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/webhooks/count.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Existing Webhook Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/webhooks/count.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Existing Webhook Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/webhooks/count.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Existing Webhook Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/webhooks/count.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Existing Webhook Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/webhooks/count.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Existing Webhook Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/webhooks/count.json", "params": [ { "name": "address", "value": "", "type": "query", "description": "Retrieve webhook subscriptions that send the POST request to this URI." }, { "name": "topic", "value": "", "type": "query", "description": "Show webhook subscriptions with a given topic.\nFor a list of valid values, refer to the topic property.>" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/locations/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/locations/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/locations/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/locations/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/locations/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/locations/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of A Resource's Metafields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/metafields/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of A Resource's Metafields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/metafields/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of A Resource's Metafields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/metafields/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of A Resource's Metafields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/metafields/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of A Resource's Metafields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/metafields/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of A Resource's Metafields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/metafields/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#count-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/redirects/count.json", "params": [ { "name": "path", "value": "", "type": "query", "description": "Count redirects with given path." }, { "name": "target", "value": "", "type": "query", "description": "Count redirects with given target." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/redirects/count.json", "params": [ { "name": "path", "value": "", "type": "query", "description": "Count redirects with given path." }, { "name": "target", "value": "", "type": "query", "description": "Count redirects with given target." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/redirects/count.json", "params": [ { "name": "path", "value": "", "type": "query", "description": "Count redirects with given path." }, { "name": "target", "value": "", "type": "query", "description": "Count redirects with given target." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/redirects/count.json", "params": [ { "name": "path", "value": "", "type": "query", "description": "Count redirects with given path." }, { "name": "target", "value": "", "type": "query", "description": "Count redirects with given target." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/redirects/count.json", "params": [ { "name": "path", "value": "", "type": "query", "description": "Count redirects with given path." }, { "name": "target", "value": "", "type": "query", "description": "Count redirects with given target." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Url Redirects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/redirects/count.json", "params": [ { "name": "path", "value": "", "type": "query", "description": "Count redirects with given path." }, { "name": "target", "value": "", "type": "query", "description": "Count redirects with given target." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-unstable" }, { "info": { "name": "Shopify Retrieves An Order Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/orders/count.json", "params": [ { "name": "created_at_min", "value": "", "type": "query", "description": "Count orders created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count orders created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count orders last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count orders last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "status", "value": "", "type": "query", "description": "Count orders of a given status.\n (default: open)\n \n open: Count open orders.\n closed: Count closed orders.\n any: Count orders of any status." }, { "name": "financial_status", "value": "", "type": "query", "description": "Count orders of a given financial status.\n (default: any)\n \n authorized: Count authorized orders.\n pending: Count pending orders.\n paid: Count paid orders.\n refunded: Count refunded orders.\n voided: Count voided orders.\n any: Count orders of any financial status." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#count-2020-01" }, { "info": { "name": "Shopify Retrieves An Order Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/orders/count.json", "params": [ { "name": "created_at_min", "value": "", "type": "query", "description": "Count orders created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count orders created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count orders last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count orders last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "status", "value": "", "type": "query", "description": "Count orders of a given status.\n (default: open)\n \n open: Count open orders.\n closed: Count closed orders.\n any: Count orders of any status." }, { "name": "financial_status", "value": "", "type": "query", "description": "Count orders of a given financial status.\n (default: any)\n \n authorized: Count authorized orders.\n pending: Count pending orders.\n paid: Count paid orders.\n refunded: Count refunded orders.\n voided: Count voided orders.\n any: Count orders of any financial status." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Collects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/collects/count.json", "params": [ { "name": "collection_id", "value": "", "type": "query", "description": "collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Collects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/collects/count.json", "params": [ { "name": "collection_id", "value": "", "type": "query", "description": "collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Collects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/collects/count.json", "params": [ { "name": "collection_id", "value": "", "type": "query", "description": "collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Collects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/collects/count.json", "params": [ { "name": "collection_id", "value": "", "type": "query", "description": "collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Collects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/collects/count.json", "params": [ { "name": "collection_id", "value": "", "type": "query", "description": "collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Collects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/collects/count.json", "params": [ { "name": "collection_id", "value": "", "type": "query", "description": "collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of Products", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/products/count.json", "params": [ { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by 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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Products", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/products/count.json", "params": [ { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by 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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Products", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/products/count.json", "params": [ { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by 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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Products", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/products/count.json", "params": [ { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by 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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Products", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/products/count.json", "params": [ { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by 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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Products", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/products/count.json", "params": [ { "name": "vendor", "value": "", "type": "query", "description": "Filter results by product vendor." }, { "name": "product_type", "value": "", "type": "query", "description": "Filter results by product type." }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter results by 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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#count-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of Countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/countries/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/countries/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/countries/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/countries/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/countries/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/countries/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of Provinces For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/countries/:country_id/provinces/count.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Provinces For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/countries/:country_id/provinces/count.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Provinces For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/countries/:country_id/provinces/count.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Provinces For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/countries/:country_id/provinces/count.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Provinces For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/countries/:country_id/provinces/count.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Provinces For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/countries/:country_id/provinces/count.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-unstable" } ] }, { "info": { "name": "Retrieves", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Single Webhook Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Webhook Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Webhook Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Webhook Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Webhook Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Webhook Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single Script Tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_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/online-store/scripttag#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Script Tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_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/online-store/scripttag#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Script Tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_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/online-store/scripttag#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Script Tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_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/online-store/scripttag#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Script Tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_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/online-store/scripttag#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Script Tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_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/online-store/scripttag#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single Theme", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_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/online-store/theme#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Theme", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_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/online-store/theme#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Theme", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_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/online-store/theme#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Theme", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_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/online-store/theme#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Theme", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_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/online-store/theme#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Theme", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_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/online-store/theme#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/users/:user_id.json", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "user_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/users/:user_id.json", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "user_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/users/:user_id.json", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "user_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/users/:user_id.json", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "user_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/users/:user_id.json", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "user_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/users/:user_id.json", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "user_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-unstable" } ] }, { "info": { "name": "Deletes", "type": "folder" }, "items": [ { "info": { "name": "Shopify Delete A Webhook Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-2020-01" }, { "info": { "name": "Shopify Delete A Webhook Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-2020-04" }, { "info": { "name": "Shopify Delete A Webhook Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-2020-07" }, { "info": { "name": "Shopify Delete A Webhook Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-2020-10" }, { "info": { "name": "Shopify Delete A Webhook Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-2021-01" }, { "info": { "name": "Shopify Delete A Webhook Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/webhooks/:webhook_id.json", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "webhook_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-unstable" }, { "info": { "name": "Shopify Deletes An Inventory Level Of An Inventory Item At A Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/inventory_levels.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "inventory_item_id", "value": "", "type": "query", "description": "inventory_item_id" }, { "name": "location_id", "value": "", "type": "query", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#destroy-2020-01" }, { "info": { "name": "Shopify Deletes An Inventory Level Of An Inventory Item At A Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/inventory_levels.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "inventory_item_id", "value": "", "type": "query", "description": "inventory_item_id" }, { "name": "location_id", "value": "", "type": "query", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#destroy-2020-04" }, { "info": { "name": "Shopify Deletes An Inventory Level Of An Inventory Item At A Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/inventory_levels.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "inventory_item_id", "value": "", "type": "query", "description": "inventory_item_id" }, { "name": "location_id", "value": "", "type": "query", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#destroy-2020-07" }, { "info": { "name": "Shopify Deletes An Inventory Level Of An Inventory Item At A Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/inventory_levels.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "inventory_item_id", "value": "", "type": "query", "description": "inventory_item_id" }, { "name": "location_id", "value": "", "type": "query", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#destroy-2020-10" }, { "info": { "name": "Shopify Deletes An Inventory Level Of An Inventory Item At A Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/inventory_levels.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "inventory_item_id", "value": "", "type": "query", "description": "inventory_item_id" }, { "name": "location_id", "value": "", "type": "query", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#destroy-2021-01" }, { "info": { "name": "Shopify Deletes An Inventory Level Of An Inventory Item At A Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/inventory_levels.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "inventory_item_id", "value": "", "type": "query", "description": "inventory_item_id" }, { "name": "location_id", "value": "", "type": "query", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#destroy-unstable" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-01" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-04" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-07" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-10" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2021-01" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-unstable" }, { "info": { "name": "Shopify Deletes A Redirect", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2020-01" }, { "info": { "name": "Shopify Deletes A Redirect", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2020-04" }, { "info": { "name": "Shopify Deletes A Redirect", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2020-07" }, { "info": { "name": "Shopify Deletes A Redirect", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2020-10" }, { "info": { "name": "Shopify Deletes A Redirect", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2021-01" }, { "info": { "name": "Shopify Deletes A Redirect", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-unstable" }, { "info": { "name": "Shopify Deletes A Script Tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#destroy-2020-01" }, { "info": { "name": "Shopify Deletes A Script Tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#destroy-2020-04" }, { "info": { "name": "Shopify Deletes A Script Tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#destroy-2020-07" }, { "info": { "name": "Shopify Deletes A Script Tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#destroy-2020-10" }, { "info": { "name": "Shopify Deletes A Script Tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#destroy-2021-01" }, { "info": { "name": "Shopify Deletes A Script Tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#destroy-unstable" }, { "info": { "name": "Shopify Deletes A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#destroy-2020-01" }, { "info": { "name": "Shopify Deletes A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#destroy-2020-04" }, { "info": { "name": "Shopify Deletes A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#destroy-2020-07" }, { "info": { "name": "Shopify Deletes A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#destroy-2020-10" }, { "info": { "name": "Shopify Deletes A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#destroy-2021-01" }, { "info": { "name": "Shopify Deletes A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#destroy-unstable" }, { "info": { "name": "Shopify Deletes An Order", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#destroy-2020-01" }, { "info": { "name": "Shopify Deletes An Order", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#destroy-2020-04" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2020-01" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2020-04" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2020-07" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2020-10" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2021-01" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-unstable" }, { "info": { "name": "Shopify Deletes A Fulfillment Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#destroy-2020-01" }, { "info": { "name": "Shopify Deletes A Fulfillment Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#destroy-2020-04" }, { "info": { "name": "Shopify Deletes A Fulfillment Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#destroy-2020-07" }, { "info": { "name": "Shopify Deletes A Fulfillment Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#destroy-2020-10" }, { "info": { "name": "Shopify Deletes A Fulfillment Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#destroy-2021-01" }, { "info": { "name": "Shopify Deletes A Fulfillment Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/fulfillments/:fulfillment_id/events/:event_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "name": "event_id", "value": "", "type": "path", "description": "event_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#destroy-unstable" } ] }, { "info": { "name": "Inventory", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Inventory Items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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 Adjusts The Inventory Level Of An Inventory Item At A Single Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/inventory_levels/adjust.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available_adjustment\n required", "value": "", "type": "query", "description": "The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, \"available_adjustment\": 2 increases the current available quantity by 2, and \"available_adjustment\": -3decreases the current available quantity by 3." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#adjust-2020-01" }, { "info": { "name": "Shopify Sets The Inventory Level For An Inventory Item At A Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/inventory_levels/set.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available\n required", "value": "", "type": "query", "description": "Sets the available inventory quantity." }, { "name": "disconnect_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#set-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Adjusts The Inventory Level Of An Inventory Item At A Single Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/inventory_levels/adjust.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available_adjustment\n required", "value": "", "type": "query", "description": "The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, \"available_adjustment\": 2 increases the current available quantity by 2, and \"available_adjustment\": -3decreases the current available quantity by 3." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#adjust-2020-04" }, { "info": { "name": "Shopify Sets The Inventory Level For An Inventory Item At A Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/inventory_levels/set.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available\n required", "value": "", "type": "query", "description": "Sets the available inventory quantity." }, { "name": "disconnect_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#set-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Adjusts The Inventory Level Of An Inventory Item At A Single Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/inventory_levels/adjust.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available_adjustment\n required", "value": "", "type": "query", "description": "The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, \"available_adjustment\": 2 increases the current available quantity by 2, and \"available_adjustment\": -3decreases the current available quantity by 3." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#adjust-2020-07" }, { "info": { "name": "Shopify Sets The Inventory Level For An Inventory Item At A Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/inventory_levels/set.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available\n required", "value": "", "type": "query", "description": "Sets the available inventory quantity." }, { "name": "disconnect_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#set-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Adjusts The Inventory Level Of An Inventory Item At A Single Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/inventory_levels/adjust.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available_adjustment\n required", "value": "", "type": "query", "description": "The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, \"available_adjustment\": 2 increases the current available quantity by 2, and \"available_adjustment\": -3decreases the current available quantity by 3." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#adjust-2020-10" }, { "info": { "name": "Shopify Sets The Inventory Level For An Inventory Item At A Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/inventory_levels/set.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available\n required", "value": "", "type": "query", "description": "Sets the available inventory quantity." }, { "name": "disconnect_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#set-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Adjusts The Inventory Level Of An Inventory Item At A Single Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/inventory_levels/adjust.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available_adjustment\n required", "value": "", "type": "query", "description": "The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, \"available_adjustment\": 2 increases the current available quantity by 2, and \"available_adjustment\": -3decreases the current available quantity by 3." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#adjust-2021-01" }, { "info": { "name": "Shopify Sets The Inventory Level For An Inventory Item At A Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/inventory_levels/set.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available\n required", "value": "", "type": "query", "description": "Sets the available inventory quantity." }, { "name": "disconnect_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#set-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Adjusts The Inventory Level Of An Inventory Item At A Single Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/inventory_levels/adjust.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available_adjustment\n required", "value": "", "type": "query", "description": "The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, \"available_adjustment\": 2 increases the current available quantity by 2, and \"available_adjustment\": -3decreases the current available quantity by 3." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#adjust-unstable" }, { "info": { "name": "Shopify Sets The Inventory Level For An Inventory Item At A Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/inventory_levels/set.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID for the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "available\n required", "value": "", "type": "query", "description": "Sets the available inventory quantity." }, { "name": "disconnect_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#set-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Inventory Levels For A Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "Identifiers", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_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/metafield#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_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/metafield#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_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/metafield#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_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/metafield#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_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/metafield#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_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/metafield#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-unstable" } ] }, { "info": { "name": "Existing", "type": "folder" }, "items": [ { "info": { "name": "Shopify Updates An Existing Inventory Item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#update-2020-01" }, { "info": { "name": "Shopify Updates An Existing Inventory Item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#update-2020-04" }, { "info": { "name": "Shopify Updates An Existing Inventory Item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#update-2020-07" }, { "info": { "name": "Shopify Updates An Existing Inventory Item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#update-2020-10" }, { "info": { "name": "Shopify Updates An Existing Inventory Item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#update-2021-01" }, { "info": { "name": "Shopify Updates An Existing Inventory Item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#update-unstable" }, { "info": { "name": "Shopify Updates An Existing Redirect", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2020-01" }, { "info": { "name": "Shopify Updates An Existing Redirect", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2020-04" }, { "info": { "name": "Shopify Updates An Existing Redirect", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2020-07" }, { "info": { "name": "Shopify Updates An Existing Redirect", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2020-10" }, { "info": { "name": "Shopify Updates An Existing Redirect", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2021-01" }, { "info": { "name": "Shopify Updates An Existing Redirect", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-unstable" }, { "info": { "name": "Shopify Updates An Existing Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#update-2020-01" }, { "info": { "name": "Shopify Updates An Existing Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#update-2020-04" }, { "info": { "name": "Shopify Updates An Existing Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#update-2020-07" }, { "info": { "name": "Shopify Updates An Existing Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#update-2020-10" }, { "info": { "name": "Shopify Updates An Existing Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#update-2021-01" }, { "info": { "name": "Shopify Updates An Existing Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/themes/:theme_id.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#update-unstable" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-01" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-04" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-07" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-10" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2021-01" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-unstable" }, { "info": { "name": "Shopify Retrieves The Payment Information For An Existing Payment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/checkouts/:token/payments/:payment_id.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "payment_id", "value": "", "type": "path", "description": "payment_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-01" }, { "info": { "name": "Shopify Retrieves The Payment Information For An Existing Payment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/checkouts/:token/payments/:payment_id.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "payment_id", "value": "", "type": "path", "description": "payment_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-04" }, { "info": { "name": "Shopify Retrieves The Payment Information For An Existing Payment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/checkouts/:token/payments/:payment_id.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "payment_id", "value": "", "type": "path", "description": "payment_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-07" }, { "info": { "name": "Shopify Retrieves The Payment Information For An Existing Payment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/checkouts/:token/payments/:payment_id.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "payment_id", "value": "", "type": "path", "description": "payment_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-10" }, { "info": { "name": "Shopify Retrieves The Payment Information For An Existing Payment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/checkouts/:token/payments/:payment_id.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "payment_id", "value": "", "type": "path", "description": "payment_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2021-01" }, { "info": { "name": "Shopify Retrieves The Payment Information For An Existing Payment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/checkouts/:token/payments/:payment_id.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "payment_id", "value": "", "type": "path", "description": "payment_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-unstable" } ] }, { "info": { "name": "Connects", "type": "folder" }, "items": [ { "info": { "name": "Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/inventory_levels/connect.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "relocate_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2020-01" }, { "info": { "name": "Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/inventory_levels/connect.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "relocate_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2020-04" }, { "info": { "name": "Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/inventory_levels/connect.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "relocate_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2020-07" }, { "info": { "name": "Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/inventory_levels/connect.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "relocate_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2020-10" }, { "info": { "name": "Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/inventory_levels/connect.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "relocate_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2021-01" }, { "info": { "name": "Shopify Connects An Inventory Item To A Location By Creating An Inventory Level At That Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/inventory_levels/connect.json", "params": [ { "name": "inventory_item_id\n required", "value": "", "type": "query", "description": "The ID of the inventory item." }, { "name": "location_id\n required", "value": "", "type": "query", "description": "The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource." }, { "name": "relocate_if_necessary", "value": "", "type": "query", "description": "Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations.\n (default: false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-unstable" } ] }, { "info": { "name": "Belong", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "Resource", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A New Metafield For A Resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/metafields.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2020-01" }, { "info": { "name": "Shopify Creates A New Metafield For A Resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/metafields.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2020-04" }, { "info": { "name": "Shopify Creates A New Metafield For A Resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/metafields.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2020-07" }, { "info": { "name": "Shopify Creates A New Metafield For A Resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/metafields.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2020-10" }, { "info": { "name": "Shopify Creates A New Metafield For A Resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/metafields.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2021-01" }, { "info": { "name": "Shopify Creates A New Metafield For A Resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/metafields.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#create-unstable" } ] }, { "info": { "name": "Admin", "type": "folder" }, "items": [ { "info": { "name": "Shopify Updates A Metafield", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2020-01" }, { "info": { "name": "Shopify Updates A Metafield", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2020-04" }, { "info": { "name": "Shopify Updates A Metafield", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2020-07" }, { "info": { "name": "Shopify Updates A Metafield", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2020-10" }, { "info": { "name": "Shopify Updates A Metafield", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2021-01" }, { "info": { "name": "Shopify Updates A Metafield", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#update-unstable" } ] }, { "info": { "name": "Article", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates An Article For A Blog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Article", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specifed by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2020-01" }, { "info": { "name": "Shopify Updates An Article", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#update-2020-01" }, { "info": { "name": "Shopify Deletes An Article", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#destroy-2020-01" }, { "info": { "name": "Shopify Creates An Article For A Blog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Article", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specifed by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2020-04" }, { "info": { "name": "Shopify Updates An Article", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#update-2020-04" }, { "info": { "name": "Shopify Deletes An Article", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#destroy-2020-04" }, { "info": { "name": "Shopify Creates An Article For A Blog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Article", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specifed by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2020-07" }, { "info": { "name": "Shopify Updates An Article", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#update-2020-07" }, { "info": { "name": "Shopify Deletes An Article", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#destroy-2020-07" }, { "info": { "name": "Shopify Creates An Article For A Blog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Article", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specifed by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2020-10" }, { "info": { "name": "Shopify Updates An Article", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#update-2020-10" }, { "info": { "name": "Shopify Deletes An Article", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#destroy-2020-10" }, { "info": { "name": "Shopify Creates An Article For A Blog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Article", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specifed by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2021-01" }, { "info": { "name": "Shopify Updates An Article", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#update-2021-01" }, { "info": { "name": "Shopify Deletes An Article", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#destroy-2021-01" }, { "info": { "name": "Shopify Creates An Article For A Blog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/blogs/:blog_id/articles.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Article", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specifed by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-unstable" }, { "info": { "name": "Shopify Updates An Article", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#update-unstable" }, { "info": { "name": "Shopify Deletes An Article", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/blogs/:blog_id/articles/:article_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "article_id", "value": "", "type": "path", "description": "article_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/article#destroy-unstable" }, { "info": { "name": "Shopify Creates A Comment For An Article", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/comments.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#create-2020-01" }, { "info": { "name": "Shopify Updates A Comment Of An Article", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/comments/:comment_id.json", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "comment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#update-2020-01" } ] }, { "info": { "name": "Assets", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Single Asset For A Theme By Its Key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-01" }, { "info": { "name": "Shopify Creates Or Updates An Asset For A Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "src", "value": "", "type": "query", "description": "The source URL of an image. Include in the body of the PUT request to upload the image to Shopify." }, { "name": "source_key", "value": "", "type": "query", "description": "The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2020-01" }, { "info": { "name": "Shopify Deletes An Asset From A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Asset For A Theme By Its Key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-04" }, { "info": { "name": "Shopify Creates Or Updates An Asset For A Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "src", "value": "", "type": "query", "description": "The source URL of an image. Include in the body of the PUT request to upload the image to Shopify." }, { "name": "source_key", "value": "", "type": "query", "description": "The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2020-04" }, { "info": { "name": "Shopify Deletes An Asset From A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Asset For A Theme By Its Key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-07" }, { "info": { "name": "Shopify Creates Or Updates An Asset For A Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "src", "value": "", "type": "query", "description": "The source URL of an image. Include in the body of the PUT request to upload the image to Shopify." }, { "name": "source_key", "value": "", "type": "query", "description": "The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2020-07" }, { "info": { "name": "Shopify Deletes An Asset From A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Asset For A Theme By Its Key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-10" }, { "info": { "name": "Shopify Creates Or Updates An Asset For A Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "src", "value": "", "type": "query", "description": "The source URL of an image. Include in the body of the PUT request to upload the image to Shopify." }, { "name": "source_key", "value": "", "type": "query", "description": "The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2020-10" }, { "info": { "name": "Shopify Deletes An Asset From A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Asset For A Theme By Its Key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2021-01" }, { "info": { "name": "Shopify Creates Or Updates An Asset For A Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "src", "value": "", "type": "query", "description": "The source URL of an image. Include in the body of the PUT request to upload the image to Shopify." }, { "name": "source_key", "value": "", "type": "query", "description": "The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2021-01" }, { "info": { "name": "Shopify Deletes An Asset From A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Asset For A Theme By Its Key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-unstable" }, { "info": { "name": "Shopify Creates Or Updates An Asset For A Theme", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "src", "value": "", "type": "query", "description": "The source URL of an image. Include in the body of the PUT request to upload the image to Shopify." }, { "name": "source_key", "value": "", "type": "query", "description": "The path within the theme to an existing asset. Include in the body of the PUT request to create a duplicate asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-unstable" }, { "info": { "name": "Shopify Deletes An Asset From A Theme", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/themes/:theme_id/assets.json", "params": [ { "name": "theme_id", "value": "", "type": "path", "description": "theme_id" }, { "name": "asset[key]", "value": "", "type": "query", "description": "asset[key]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-unstable" } ] }, { "info": { "name": "Blog", "type": "folder" }, "items": [ { "info": { "name": "Shopify Create A New Blog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/blogs.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#create-2020-01" }, { "info": { "name": "Shopify Get A Single Blog By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/blogs/:blog_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "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#show-2020-01" }, { "info": { "name": "Shopify Update A Blog", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/blogs/:blog_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#update-2020-01" }, { "info": { "name": "Shopify Delete A Blog", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/blogs/:blog_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#destroy-2020-01" } ] }, { "info": { "name": "Comments", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Comments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Comments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/comments/count.json", "params": [ { "name": "created_at_min", "value": "", "type": "query", "description": "Count comments created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count comments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count comments last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count comments last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count comments published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count comments published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Retrieve a count of comments with a given published status.\n (default: any)\n \n published: Count only published comments.\n unpublished: Count only unpublished comments.\n any: Count comments of any published status." }, { "name": "status", "value": "", "type": "query", "description": "Retrieve a count of comments with a given status.\n \n pending: Count pending comments.\n published: Count published comments.\n unapproved: Count 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#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Comment By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/comments/:comment_id.json", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "comment_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/online-store/comment#show-2020-01" }, { "info": { "name": "Shopify Marks A Comment As Spam", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/comments/:comment_id/spam.json", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "comment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#spam-2020-01" }, { "info": { "name": "Shopify Marks A Comment As Not Spam", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/comments/:comment_id/not_spam.json", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "comment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#not_spam-2020-01" }, { "info": { "name": "Shopify Removes A Comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/comments/:comment_id/remove.json", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "comment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#remove-2020-01" }, { "info": { "name": "Shopify Restores A Previously Removed Comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/comments/:comment_id/restore.json", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "comment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#restore-2020-01" } ] }, { "info": { "name": "Approves", "type": "folder" }, "items": [ { "info": { "name": "Shopify Approves A Comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/comments/:comment_id/approve.json", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "comment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#approve-2020-01" } ] }, { "info": { "name": "Redirect", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A Redirect", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/redirects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Redirect", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_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/online-store/redirect#show-2020-01" }, { "info": { "name": "Shopify Creates A Redirect", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/redirects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Redirect", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_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/online-store/redirect#show-2020-04" }, { "info": { "name": "Shopify Creates A Redirect", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/redirects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Redirect", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_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/online-store/redirect#show-2020-07" }, { "info": { "name": "Shopify Creates A Redirect", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/redirects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Redirect", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_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/online-store/redirect#show-2020-10" }, { "info": { "name": "Shopify Creates A Redirect", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/redirects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Redirect", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_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/online-store/redirect#show-2021-01" }, { "info": { "name": "Shopify Creates A Redirect", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/redirects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Redirect", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/redirects/:redirect_id.json", "params": [ { "name": "redirect_id", "value": "", "type": "path", "description": "redirect_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/online-store/redirect#show-unstable" } ] }, { "info": { "name": "Script", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A New Script Tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/script_tags.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2020-01" }, { "info": { "name": "Shopify Updates A Script Tag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2020-01" }, { "info": { "name": "Shopify Creates A New Script Tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/script_tags.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2020-04" }, { "info": { "name": "Shopify Updates A Script Tag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2020-04" }, { "info": { "name": "Shopify Creates A New Script Tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/script_tags.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2020-07" }, { "info": { "name": "Shopify Updates A Script Tag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2020-07" }, { "info": { "name": "Shopify Creates A New Script Tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/script_tags.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2020-10" }, { "info": { "name": "Shopify Updates A Script Tag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2020-10" }, { "info": { "name": "Shopify Creates A New Script Tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/script_tags.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2021-01" }, { "info": { "name": "Shopify Updates A Script Tag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2021-01" }, { "info": { "name": "Shopify Creates A New Script Tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/script_tags.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-unstable" }, { "info": { "name": "Shopify Updates A Script Tag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/script_tags/:script_tag_id.json", "params": [ { "name": "script_tag_id", "value": "", "type": "path", "description": "script_tag_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-unstable" } ] }, { "info": { "name": "Contains", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A Theme By Providing The Public Url Of A Zip File That Contains The Theme", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/themes.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#create-2020-01" }, { "info": { "name": "Shopify Creates A Theme By Providing The Public Url Of A Zip File That Contains The Theme", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/themes.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#create-2020-04" }, { "info": { "name": "Shopify Creates A Theme By Providing The Public Url Of A Zip File That Contains The Theme", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/themes.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#create-2020-07" }, { "info": { "name": "Shopify Creates A Theme By Providing The Public Url Of A Zip File That Contains The Theme", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/themes.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#create-2020-10" }, { "info": { "name": "Shopify Creates A Theme By Providing The Public Url Of A Zip File That Contains The Theme", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/themes.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#create-2021-01" }, { "info": { "name": "Shopify Creates A Theme By Providing The Public Url Of A Zip File That Contains The Theme", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/themes.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#create-unstable" } ] }, { "info": { "name": "Checkouts", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Count Of Checkouts From The Past 90 Days", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/checkouts/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "status", "value": "", "type": "query", "description": "Count checkouts with a given status.\n (default: open)\n \n open: Count only open abandoned checkouts.\n closed: Count only closed abandoned checkouts." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Checkouts From The Past 90 Days", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/checkouts/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "status", "value": "", "type": "query", "description": "Count checkouts with a given status.\n (default: open)\n \n open: Count only open abandoned checkouts.\n closed: Count only closed abandoned checkouts." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Checkouts From The Past 90 Days", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/checkouts/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "status", "value": "", "type": "query", "description": "Count checkouts with a given status.\n (default: open)\n \n open: Count only open abandoned checkouts.\n closed: Count only closed abandoned checkouts." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Checkouts From The Past 90 Days", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/checkouts/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "status", "value": "", "type": "query", "description": "Count checkouts with a given status.\n (default: open)\n \n open: Count only open abandoned checkouts.\n closed: Count only closed abandoned checkouts." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Checkouts From The Past 90 Days", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/checkouts/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "status", "value": "", "type": "query", "description": "Count checkouts with a given status.\n (default: open)\n \n open: Count only open abandoned checkouts.\n closed: Count only closed abandoned checkouts." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Checkouts From The Past 90 Days", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/checkouts/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)" }, { "name": "status", "value": "", "type": "query", "description": "Count checkouts with a given status.\n (default: open)\n \n open: Count only open abandoned checkouts.\n closed: Count only closed abandoned checkouts." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-unstable" } ] }, { "info": { "name": "Checkout", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/checkouts.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2020-01" }, { "info": { "name": "Shopify Creates A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/checkouts.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2020-04" }, { "info": { "name": "Shopify Creates A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/checkouts.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2020-07" }, { "info": { "name": "Shopify Creates A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/checkouts.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2020-10" }, { "info": { "name": "Shopify Creates A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/checkouts.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2021-01" }, { "info": { "name": "Shopify Creates A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/checkouts.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-unstable" }, { "info": { "name": "Shopify Completes A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/checkouts/:token/complete.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2020-01" }, { "info": { "name": "Shopify Retrieves A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-01" }, { "info": { "name": "Shopify Modifies An Existing Checkout", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2020-01" }, { "info": { "name": "Shopify Completes A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/checkouts/:token/complete.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2020-04" }, { "info": { "name": "Shopify Retrieves A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-04" }, { "info": { "name": "Shopify Modifies An Existing Checkout", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2020-04" }, { "info": { "name": "Shopify Completes A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/checkouts/:token/complete.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2020-07" }, { "info": { "name": "Shopify Retrieves A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-07" }, { "info": { "name": "Shopify Modifies An Existing Checkout", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2020-07" }, { "info": { "name": "Shopify Completes A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/checkouts/:token/complete.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2020-10" }, { "info": { "name": "Shopify Retrieves A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-10" }, { "info": { "name": "Shopify Modifies An Existing Checkout", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2020-10" }, { "info": { "name": "Shopify Completes A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/checkouts/:token/complete.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2021-01" }, { "info": { "name": "Shopify Retrieves A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2021-01" }, { "info": { "name": "Shopify Modifies An Existing Checkout", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2021-01" }, { "info": { "name": "Shopify Completes A Checkout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/checkouts/:token/complete.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-unstable" }, { "info": { "name": "Shopify Retrieves A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-unstable" }, { "info": { "name": "Shopify Modifies An Existing Checkout", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/checkouts/:token.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Counts The Number Of Payments Attempted On A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/checkouts/:token/payments/count.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Counts The Number Of Payments Attempted On A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/checkouts/:token/payments/count.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Counts The Number Of Payments Attempted On A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/checkouts/:token/payments/count.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Counts The Number Of Payments Attempted On A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/checkouts/:token/payments/count.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Counts The Number Of Payments Attempted On A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/checkouts/:token/payments/count.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Payments On A Particular Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Counts The Number Of Payments Attempted On A Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/checkouts/:token/payments/count.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-unstable" } ] }, { "info": { "name": "Order", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates An Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "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#show-2020-01" }, { "info": { "name": "Shopify Updates An Order", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#update-2020-01" }, { "info": { "name": "Shopify Closes An Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/close.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#close-2020-01" }, { "info": { "name": "Shopify Re-opens A Closed Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/open.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#open-2020-01" }, { "info": { "name": "Shopify Creates An Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "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#show-2020-04" }, { "info": { "name": "Shopify Updates An Order", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#update-2020-04" }, { "info": { "name": "Shopify Closes An Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/close.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#close-2020-04" }, { "info": { "name": "Shopify Re-opens A Closed Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/open.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#open-2020-04" }, { "info": { "name": "Shopify Creates An Order Risk For An Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-01" }, { "info": { "name": "Shopify Creates An Order Risk For An Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-04" }, { "info": { "name": "Shopify Creates An Order Risk For An Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-07" }, { "info": { "name": "Shopify Creates An Order Risk For An Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-10" }, { "info": { "name": "Shopify Creates An Order Risk For An Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2021-01" }, { "info": { "name": "Shopify Creates An Order Risk For An Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/risks.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-unstable" } ] }, { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "amount", "value": "", "type": "query", "description": "The amount to refund. If set, Shopify attempts to void or refund the payment, depending on its status. Shopify refunds through a manual gateway in cases where the original transaction was not made in Shopify. Refunds through a manual gateway are recorded as a refund on Shopify, but the customer is not refunded." }, { "name": "currency", "value": "", "type": "query", "description": "The currency of the refund that's issued when the order is canceled. Required for multi-currency orders whenever the amount property is provided." }, { "name": "restock\n deprecated", "value": "", "type": "query", "description": "Whether to restock refunded items back to your store's inventory.\n (default: false)" }, { "name": "reason", "value": "", "type": "query", "description": "The reason for the order cancellation. Valid values: customer, inventory, fraud, declined, and other.)\n (default: other)" }, { "name": "email", "value": "", "type": "query", "description": "Whether to send an email to the customer notifying them of the cancellation.\n (default: false)" }, { "name": "refund", "value": "", "type": "query", "description": "The refund transactions to perform. Required for some more complex refund situations. For more information, see the Refund API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#cancel-2020-01" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "amount", "value": "", "type": "query", "description": "The amount to refund. If set, Shopify attempts to void or refund the payment, depending on its status. Shopify refunds through a manual gateway in cases where the original transaction was not made in Shopify. Refunds through a manual gateway are recorded as a refund on Shopify, but the customer is not refunded." }, { "name": "currency", "value": "", "type": "query", "description": "The currency of the refund that's issued when the order is canceled. Required for multi-currency orders whenever the amount property is provided." }, { "name": "restock\n deprecated", "value": "", "type": "query", "description": "Whether to restock refunded items back to your store's inventory.\n (default: false)" }, { "name": "reason", "value": "", "type": "query", "description": "The reason for the order cancellation. Valid values: customer, inventory, fraud, declined, and other.)\n (default: other)" }, { "name": "email", "value": "", "type": "query", "description": "Whether to send an email to the customer notifying them of the cancellation.\n (default: false)" }, { "name": "refund", "value": "", "type": "query", "description": "The refund transactions to perform. Required for some more complex refund situations. For more information, see the Refund API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order#cancel-2020-04" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "restock\n deprecated", "value": "", "type": "query", "description": "Whether to add the line items back to the store inventory. Use restock_type for refund line items instead." }, { "name": "notify", "value": "", "type": "query", "description": "Whether to send a refund notification to the customer." }, { "name": "note", "value": "", "type": "query", "description": "An optional note attached to a refund." }, { "name": "discrepancy_reason", "value": "", "type": "query", "description": "An optional comment that explains a discrepancy between calculated and actual refund amounts. Used to populate the reason property of the resulting order adjustment object attached to the refund. Valid values: restock, damage, customer, and other." }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled.\n The canceled quantity will be added back to the available count.\n The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count. The number of fulfillable units for this\n line item will remain unchanged.\n \n\n location_id: The ID of the location where the items should be\n restocked. This is required when the value of restock_type is return or cancel.\n If the item is not already stocked at the location, then\n the item is connected to the location. An error is returned when the item is connected to\n a \n fulfillment service location and a different location is provided." }, { "name": "transactions", "value": "", "type": "query", "description": "A list of transactions\n to process as refunds." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the currency used for the refund." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#create-2020-01" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/refunds/calculate.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled. The canceled quantity will be added\n back to the available count. The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count.\n The number of fulfillable units for this line item will remain unchanged.\n \n\n location_id: The ID of the location\n where the items should be restocked. If location_id is not provided and the value of\n restock_type is return or cancel, then the endpoint returns a suitable\n location ID.\n\n already_stocked: Whether the item is already stocked at\n the location. If this is false, then creating the refund will connect the item to the location and start\n stocking it there." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the\n currency used for the refund. Note: Required whenever the shipping amount property is provided." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#calculate-2020-01" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "restock\n deprecated", "value": "", "type": "query", "description": "Whether to add the line items back to the store inventory. Use restock_type for refund line items instead." }, { "name": "notify", "value": "", "type": "query", "description": "Whether to send a refund notification to the customer." }, { "name": "note", "value": "", "type": "query", "description": "An optional note attached to a refund." }, { "name": "discrepancy_reason", "value": "", "type": "query", "description": "An optional comment that explains a discrepancy between calculated and actual refund amounts. Used to populate the reason property of the resulting order adjustment object attached to the refund. Valid values: restock, damage, customer, and other." }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled.\n The canceled quantity will be added back to the available count.\n The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count. The number of fulfillable units for this\n line item will remain unchanged.\n \n\n location_id: The ID of the location where the items should be\n restocked. This is required when the value of restock_type is return or cancel.\n If the item is not already stocked at the location, then\n the item is connected to the location. An error is returned when the item is connected to\n a \n fulfillment service location and a different location is provided." }, { "name": "transactions", "value": "", "type": "query", "description": "A list of transactions\n to process as refunds." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the currency used for the refund." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#create-2020-04" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/refunds/calculate.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled. The canceled quantity will be added\n back to the available count. The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count.\n The number of fulfillable units for this line item will remain unchanged.\n \n\n location_id: The ID of the location\n where the items should be restocked. If location_id is not provided and the value of\n restock_type is return or cancel, then the endpoint returns a suitable\n location ID.\n\n already_stocked: Whether the item is already stocked at\n the location. If this is false, then creating the refund will connect the item to the location and start\n stocking it there." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the\n currency used for the refund. Note: Required whenever the shipping amount property is provided." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#calculate-2020-04" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "restock\n deprecated", "value": "", "type": "query", "description": "Whether to add the line items back to the store inventory. Use restock_type for refund line items instead." }, { "name": "notify", "value": "", "type": "query", "description": "Whether to send a refund notification to the customer." }, { "name": "note", "value": "", "type": "query", "description": "An optional note attached to a refund." }, { "name": "discrepancy_reason", "value": "", "type": "query", "description": "An optional comment that explains a discrepancy between calculated and actual refund amounts. Used to populate the reason property of the resulting order adjustment object attached to the refund. Valid values: restock, damage, customer, and other." }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled.\n The canceled quantity will be added back to the available count.\n The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count. The number of fulfillable units for this\n line item will remain unchanged.\n \n\n location_id: The ID of the location where the items should be\n restocked. This is required when the value of restock_type is return or cancel.\n If the item is not already stocked at the location, then\n the item is connected to the location. An error is returned when the item is connected to\n a \n fulfillment service location and a different location is provided." }, { "name": "transactions", "value": "", "type": "query", "description": "A list of transactions\n to process as refunds." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the currency used for the refund." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#create-2020-07" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/refunds/calculate.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled. The canceled quantity will be added\n back to the available count. The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count.\n The number of fulfillable units for this line item will remain unchanged.\n \n\n location_id: The ID of the location\n where the items should be restocked. If location_id is not provided and the value of\n restock_type is return or cancel, then the endpoint returns a suitable\n location ID.\n\n already_stocked: Whether the item is already stocked at\n the location. If this is false, then creating the refund will connect the item to the location and start\n stocking it there." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the\n currency used for the refund. Note: Required whenever the shipping amount property is provided." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#calculate-2020-07" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "restock\n deprecated", "value": "", "type": "query", "description": "Whether to add the line items back to the store inventory. Use restock_type for refund line items instead." }, { "name": "notify", "value": "", "type": "query", "description": "Whether to send a refund notification to the customer." }, { "name": "note", "value": "", "type": "query", "description": "An optional note attached to a refund." }, { "name": "discrepancy_reason", "value": "", "type": "query", "description": "An optional comment that explains a discrepancy between calculated and actual refund amounts. Used to populate the reason property of the resulting order adjustment object attached to the refund. Valid values: restock, damage, customer, and other." }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled.\n The canceled quantity will be added back to the available count.\n The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count. The number of fulfillable units for this\n line item will remain unchanged.\n \n\n location_id: The ID of the location where the items should be\n restocked. This is required when the value of restock_type is return or cancel.\n If the item is not already stocked at the location, then\n the item is connected to the location. An error is returned when the item is connected to\n a \n fulfillment service location and a different location is provided." }, { "name": "transactions", "value": "", "type": "query", "description": "A list of transactions\n to process as refunds." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the currency used for the refund." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#create-2020-10" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/refunds/calculate.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled. The canceled quantity will be added\n back to the available count. The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count.\n The number of fulfillable units for this line item will remain unchanged.\n \n\n location_id: The ID of the location\n where the items should be restocked. If location_id is not provided and the value of\n restock_type is return or cancel, then the endpoint returns a suitable\n location ID.\n\n already_stocked: Whether the item is already stocked at\n the location. If this is false, then creating the refund will connect the item to the location and start\n stocking it there." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the\n currency used for the refund. Note: Required whenever the shipping amount property is provided." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#calculate-2020-10" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "restock\n deprecated", "value": "", "type": "query", "description": "Whether to add the line items back to the store inventory. Use restock_type for refund line items instead." }, { "name": "notify", "value": "", "type": "query", "description": "Whether to send a refund notification to the customer." }, { "name": "note", "value": "", "type": "query", "description": "An optional note attached to a refund." }, { "name": "discrepancy_reason", "value": "", "type": "query", "description": "An optional comment that explains a discrepancy between calculated and actual refund amounts. Used to populate the reason property of the resulting order adjustment object attached to the refund. Valid values: restock, damage, customer, and other." }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled.\n The canceled quantity will be added back to the available count.\n The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count. The number of fulfillable units for this\n line item will remain unchanged.\n \n\n location_id: The ID of the location where the items should be\n restocked. This is required when the value of restock_type is return or cancel.\n If the item is not already stocked at the location, then\n the item is connected to the location. An error is returned when the item is connected to\n a \n fulfillment service location and a different location is provided." }, { "name": "transactions", "value": "", "type": "query", "description": "A list of transactions\n to process as refunds." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the currency used for the refund." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#create-2021-01" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/refunds/calculate.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled. The canceled quantity will be added\n back to the available count. The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count.\n The number of fulfillable units for this line item will remain unchanged.\n \n\n location_id: The ID of the location\n where the items should be restocked. If location_id is not provided and the value of\n restock_type is return or cancel, then the endpoint returns a suitable\n location ID.\n\n already_stocked: Whether the item is already stocked at\n the location. If this is false, then creating the refund will connect the item to the location and start\n stocking it there." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the\n currency used for the refund. Note: Required whenever the shipping amount property is provided." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#calculate-2021-01" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/refunds.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "restock\n deprecated", "value": "", "type": "query", "description": "Whether to add the line items back to the store inventory. Use restock_type for refund line items instead." }, { "name": "notify", "value": "", "type": "query", "description": "Whether to send a refund notification to the customer." }, { "name": "note", "value": "", "type": "query", "description": "An optional note attached to a refund." }, { "name": "discrepancy_reason", "value": "", "type": "query", "description": "An optional comment that explains a discrepancy between calculated and actual refund amounts. Used to populate the reason property of the resulting order adjustment object attached to the refund. Valid values: restock, damage, customer, and other." }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled.\n The canceled quantity will be added back to the available count.\n The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count. The number of fulfillable units for this\n line item will remain unchanged.\n \n\n location_id: The ID of the location where the items should be\n restocked. This is required when the value of restock_type is return or cancel.\n If the item is not already stocked at the location, then\n the item is connected to the location. An error is returned when the item is connected to\n a \n fulfillment service location and a different location is provided." }, { "name": "transactions", "value": "", "type": "query", "description": "A list of transactions\n to process as refunds." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the currency used for the refund." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#create-unstable" }, { "info": { "name": "Shopify For Multi-currency Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/refunds/calculate.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "shipping", "value": "", "type": "query", "description": "Specify how much shipping to refund. It has the following properties:\n \n full_refund: Whether to refund all remaining shipping.\n amount: Set a specific amount to refund for shipping. Takes precedence over full_refund." }, { "name": "refund_line_items", "value": "", "type": "query", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n \n line_item_id: The ID of a line item to refund.\n quantity: The quantity to refund.\n restock_type: How this refund line item affects inventory levels. Valid values:\n \n no_restock: Refunding these items won't affect inventory.\n cancel: The items have not yet been fulfilled. The canceled quantity will be added\n back to the available count. The number of fulfillable units for this line item will decrease.\n return: The items were already delivered but will be returned to the merchant.\n The returned quantity will be added back to the available count.\n The number of fulfillable units for this line item will remain unchanged.\n \n\n location_id: The ID of the location\n where the items should be restocked. If location_id is not provided and the value of\n restock_type is return or cancel, then the endpoint returns a suitable\n location ID.\n\n already_stocked: Whether the item is already stocked at\n the location. If this is false, then creating the refund will connect the item to the location and start\n stocking it there." }, { "name": "currency", "value": "", "type": "query", "description": "The three-letter code (ISO 4217 format) for the\n currency used for the refund. Note: Required whenever the shipping amount property is provided." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/refund#calculate-unstable" } ] }, { "info": { "name": "Another", "type": "folder" }, "items": [ { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-01" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-01" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-04" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-04" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-07" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-07" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-10" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-10" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2021-01" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2021-01" }, { "info": { "name": "Shopify Updates An Order Risk You Cannot Modify An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-unstable" }, { "info": { "name": "Shopify Deletes An Order Risk For An Order You Cannot Delete An Order Risk That Was Created By Another Application", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-unstable" }, { "info": { "name": "Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "new_location_id", "value": "", "type": "query", "description": "The id of the location to which the fulfillment order will be moved." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2020-01" }, { "info": { "name": "Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "new_location_id", "value": "", "type": "query", "description": "The id of the location to which the fulfillment order will be moved." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2020-04" }, { "info": { "name": "Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "new_location_id", "value": "", "type": "query", "description": "The id of the location to which the fulfillment order will be moved." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2020-07" }, { "info": { "name": "Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "new_location_id", "value": "", "type": "query", "description": "The id of the location to which the fulfillment order will be moved." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2020-10" }, { "info": { "name": "Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "new_location_id", "value": "", "type": "query", "description": "The id of the location to which the fulfillment order will be moved." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2021-01" }, { "info": { "name": "Shopify Moves A Fulfillment Order From One Merchant Managed Location To Another Merchant Managed Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/move.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "new_location_id", "value": "", "type": "query", "description": "The id of the location to which the fulfillment order will be moved." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-unstable" } ] }, { "info": { "name": "Refund", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Specific Refund", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/refunds/:refund_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "refund_id", "value": "", "type": "path", "description": "refund_id" }, { "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#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Specific Refund", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/refunds/:refund_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "refund_id", "value": "", "type": "path", "description": "refund_id" }, { "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#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Specific Refund", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/refunds/:refund_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "refund_id", "value": "", "type": "path", "description": "refund_id" }, { "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#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Specific Refund", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/refunds/:refund_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "refund_id", "value": "", "type": "path", "description": "refund_id" }, { "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#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Specific Refund", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/refunds/:refund_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "refund_id", "value": "", "type": "path", "description": "refund_id" }, { "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#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Specific Refund", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/refunds/:refund_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "refund_id", "value": "", "type": "path", "description": "refund_id" }, { "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#show-unstable" } ] }, { "info": { "name": "Cards", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/gift_cards/count.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Count gift cards with a given status. Valid values:\n \n enabled: Count only enabled gift cards\n disabled: Count only disabled gift cards" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-01" }, { "info": { "name": "Shopify Searches For Gift Cards That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/gift_cards/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "The field and direction to order results by.\n (default: disabled_at DESC)" }, { "name": "query", "value": "", "type": "query", "description": "The text to search for." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/gift_cards/count.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Count gift cards with a given status. Valid values:\n \n enabled: Count only enabled gift cards\n disabled: Count only disabled gift cards" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-04" }, { "info": { "name": "Shopify Searches For Gift Cards That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/gift_cards/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "The field and direction to order results by.\n (default: disabled_at DESC)" }, { "name": "query", "value": "", "type": "query", "description": "The text to search for." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/gift_cards/count.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Count gift cards with a given status. Valid values:\n \n enabled: Count only enabled gift cards\n disabled: Count only disabled gift cards" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-07" }, { "info": { "name": "Shopify Searches For Gift Cards That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/gift_cards/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "The field and direction to order results by.\n (default: disabled_at DESC)" }, { "name": "query", "value": "", "type": "query", "description": "The text to search for." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/gift_cards/count.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Count gift cards with a given status. Valid values:\n \n enabled: Count only enabled gift cards\n disabled: Count only disabled gift cards" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-10" }, { "info": { "name": "Shopify Searches For Gift Cards That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/gift_cards/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "The field and direction to order results by.\n (default: disabled_at DESC)" }, { "name": "query", "value": "", "type": "query", "description": "The text to search for." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/gift_cards/count.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Count gift cards with a given status. Valid values:\n \n enabled: Count only enabled gift cards\n disabled: Count only disabled gift cards" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2021-01" }, { "info": { "name": "Shopify Searches For Gift Cards That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/gift_cards/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "The field and direction to order results by.\n (default: disabled_at DESC)" }, { "name": "query", "value": "", "type": "query", "description": "The text to search for." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/gift_cards/count.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Count gift cards with a given status. Valid values:\n \n enabled: Count only enabled gift cards\n disabled: Count only disabled gift cards" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-unstable" }, { "info": { "name": "Shopify Searches For Gift Cards That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/gift_cards/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "The field and direction to order results by.\n (default: disabled_at DESC)" }, { "name": "query", "value": "", "type": "query", "description": "The text to search for." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-unstable" } ] }, { "info": { "name": "Card", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/gift_cards.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-01" }, { "info": { "name": "Shopify Updates An Existing Gift Card", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2020-01" }, { "info": { "name": "Shopify Disables A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/gift_cards/:gift_card_id/disable.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2020-01" }, { "info": { "name": "Shopify Creates A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/gift_cards.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-04" }, { "info": { "name": "Shopify Updates An Existing Gift Card", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2020-04" }, { "info": { "name": "Shopify Disables A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/gift_cards/:gift_card_id/disable.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2020-04" }, { "info": { "name": "Shopify Creates A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/gift_cards.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-07" }, { "info": { "name": "Shopify Updates An Existing Gift Card", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2020-07" }, { "info": { "name": "Shopify Disables A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/gift_cards/:gift_card_id/disable.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2020-07" }, { "info": { "name": "Shopify Creates A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/gift_cards.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-10" }, { "info": { "name": "Shopify Updates An Existing Gift Card", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2020-10" }, { "info": { "name": "Shopify Disables A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/gift_cards/:gift_card_id/disable.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2020-10" }, { "info": { "name": "Shopify Creates A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/gift_cards.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2021-01" }, { "info": { "name": "Shopify Updates An Existing Gift Card", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2021-01" }, { "info": { "name": "Shopify Disables A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/gift_cards/:gift_card_id/disable.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2021-01" }, { "info": { "name": "Shopify Creates A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/gift_cards.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-unstable" }, { "info": { "name": "Shopify Updates An Existing Gift Card", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-unstable" }, { "info": { "name": "Shopify Disables A Gift Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/gift_cards/:gift_card_id/disable.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-unstable" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-01" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-04" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-07" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-10" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2021-01" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-unstable" } ] }, { "info": { "name": "About", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/users/current.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-01" }, { "info": { "name": "Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/users/current.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-04" }, { "info": { "name": "Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/users/current.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-07" }, { "info": { "name": "Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/users/current.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-10" }, { "info": { "name": "Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/users/current.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2021-01" }, { "info": { "name": "Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/users/current.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-unstable" } ] }, { "info": { "name": "Collection", "type": "folder" }, "items": [ { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2020-01" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2020-01" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2020-04" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2020-04" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2020-07" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2020-07" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2020-10" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2020-10" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2021-01" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2021-01" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-unstable" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-unstable" }, { "info": { "name": "Shopify Retrieves A Single Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/collections/:collection_id.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_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/collection#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/collections/:collection_id.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_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/collection#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/collections/:collection_id.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_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/collection#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/collections/:collection_id.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_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/collection#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/collections/:collection_id.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_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/collection#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/collections/:collection_id.json", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "collection_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/collection#show-unstable" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_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/customcollection#show-2020-01" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2020-01" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2020-01" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_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/customcollection#show-2020-04" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2020-04" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2020-04" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_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/customcollection#show-2020-07" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2020-07" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2020-07" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_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/customcollection#show-2020-10" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2020-10" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2020-10" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_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/customcollection#show-2021-01" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2021-01" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2021-01" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_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/customcollection#show-unstable" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-unstable" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-unstable" }, { "info": { "name": "Shopify Creates A New Smart Collection Using The Specified Rules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/smart_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Smart Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_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/smartcollection#show-2020-01" }, { "info": { "name": "Shopify Updates An Existing Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#update-2020-01" }, { "info": { "name": "Shopify Removes A Smart Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#destroy-2020-01" }, { "info": { "name": "Shopify Updates The Ordering Type Of Products In A Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/smart_collections/:smart_collection_id/order.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" }, { "name": "products", "value": "", "type": "query", "description": "An array of product IDs, in the order that you want them to appear at the top of the collection. When products is specified but empty, any previously sorted products are cleared." }, { "name": "sort_order", "value": "", "type": "query", "description": "The type of sorting to apply. Valid values are listed in the Properties section above.\n (default: (current value))" }, { "name": "products[]", "value": "", "type": "query", "description": "products[]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#order-2020-01" }, { "info": { "name": "Shopify Creates A New Smart Collection Using The Specified Rules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/smart_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Smart Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_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/smartcollection#show-2020-04" }, { "info": { "name": "Shopify Updates An Existing Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#update-2020-04" }, { "info": { "name": "Shopify Removes A Smart Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#destroy-2020-04" }, { "info": { "name": "Shopify Updates The Ordering Type Of Products In A Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/smart_collections/:smart_collection_id/order.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" }, { "name": "products", "value": "", "type": "query", "description": "An array of product IDs, in the order that you want them to appear at the top of the collection. When products is specified but empty, any previously sorted products are cleared." }, { "name": "sort_order", "value": "", "type": "query", "description": "The type of sorting to apply. Valid values are listed in the Properties section above.\n (default: (current value))" }, { "name": "products[]", "value": "", "type": "query", "description": "products[]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#order-2020-04" }, { "info": { "name": "Shopify Creates A New Smart Collection Using The Specified Rules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/smart_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Smart Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_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/smartcollection#show-2020-07" }, { "info": { "name": "Shopify Updates An Existing Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#update-2020-07" }, { "info": { "name": "Shopify Removes A Smart Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#destroy-2020-07" }, { "info": { "name": "Shopify Updates The Ordering Type Of Products In A Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/smart_collections/:smart_collection_id/order.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" }, { "name": "products", "value": "", "type": "query", "description": "An array of product IDs, in the order that you want them to appear at the top of the collection. When products is specified but empty, any previously sorted products are cleared." }, { "name": "sort_order", "value": "", "type": "query", "description": "The type of sorting to apply. Valid values are listed in the Properties section above.\n (default: (current value))" }, { "name": "products[]", "value": "", "type": "query", "description": "products[]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#order-2020-07" }, { "info": { "name": "Shopify Creates A New Smart Collection Using The Specified Rules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/smart_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Smart Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_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/smartcollection#show-2020-10" }, { "info": { "name": "Shopify Updates An Existing Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#update-2020-10" }, { "info": { "name": "Shopify Removes A Smart Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#destroy-2020-10" }, { "info": { "name": "Shopify Updates The Ordering Type Of Products In A Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/smart_collections/:smart_collection_id/order.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" }, { "name": "products", "value": "", "type": "query", "description": "An array of product IDs, in the order that you want them to appear at the top of the collection. When products is specified but empty, any previously sorted products are cleared." }, { "name": "sort_order", "value": "", "type": "query", "description": "The type of sorting to apply. Valid values are listed in the Properties section above.\n (default: (current value))" }, { "name": "products[]", "value": "", "type": "query", "description": "products[]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#order-2020-10" }, { "info": { "name": "Shopify Creates A New Smart Collection Using The Specified Rules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/smart_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Smart Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_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/smartcollection#show-2021-01" }, { "info": { "name": "Shopify Updates An Existing Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#update-2021-01" }, { "info": { "name": "Shopify Removes A Smart Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#destroy-2021-01" }, { "info": { "name": "Shopify Updates The Ordering Type Of Products In A Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/smart_collections/:smart_collection_id/order.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" }, { "name": "products", "value": "", "type": "query", "description": "An array of product IDs, in the order that you want them to appear at the top of the collection. When products is specified but empty, any previously sorted products are cleared." }, { "name": "sort_order", "value": "", "type": "query", "description": "The type of sorting to apply. Valid values are listed in the Properties section above.\n (default: (current value))" }, { "name": "products[]", "value": "", "type": "query", "description": "products[]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#order-2021-01" }, { "info": { "name": "Shopify Creates A New Smart Collection Using The Specified Rules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/smart_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Smart Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_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/smartcollection#show-unstable" }, { "info": { "name": "Shopify Updates An Existing Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#update-unstable" }, { "info": { "name": "Shopify Removes A Smart Collection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/smart_collections/:smart_collection_id.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#destroy-unstable" }, { "info": { "name": "Shopify Updates The Ordering Type Of Products In A Smart Collection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/smart_collections/:smart_collection_id/order.json", "params": [ { "name": "smart_collection_id", "value": "", "type": "path", "description": "smart_collection_id" }, { "name": "products", "value": "", "type": "query", "description": "An array of product IDs, in the order that you want them to appear at the top of the collection. When products is specified but empty, any previously sorted products are cleared." }, { "name": "sort_order", "value": "", "type": "query", "description": "The type of sorting to apply. Valid values are listed in the Properties section above.\n (default: (current value))" }, { "name": "products[]", "value": "", "type": "query", "description": "products[]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#order-unstable" } ] }, { "info": { "name": "Collect", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_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#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_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#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_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#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_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#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_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#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_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#show-unstable" } ] }, { "info": { "name": "Belonging", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieve A List Of Products Belonging To A Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "Collections", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/smart_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that include the specified product." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/smart_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that include the specified product." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/smart_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that include the specified product." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/smart_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that include the specified product." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/smart_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that include the specified product." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Count Of Smart Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/smart_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Show smart collections with the specified title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show smart collections that include the specified product." }, { "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." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-unstable" } ] }, { "info": { "name": "Product", "type": "folder" }, "items": [ { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_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/products/product#show-2020-01" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_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/products/product#show-2020-04" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_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/products/product#show-2020-07" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_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/products/product#show-2020-10" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_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/products/product#show-2021-01" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_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/products/product#show-unstable" } ] }, { "info": { "name": "Images", "type": "folder" }, "items": [ { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2020-01" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2020-04" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2020-07" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2020-10" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2021-01" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-unstable" } ] }, { "info": { "name": "Create", "type": "folder" }, "items": [ { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2020-01" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2020-04" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2020-07" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2020-10" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2021-01" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-unstable" }, { "info": { "name": "Shopify Create A Fulfillment For The Specified Order And Line Items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2020-01" }, { "info": { "name": "Shopify Create A Fulfillment For The Specified Order And Line Items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2020-04" }, { "info": { "name": "Shopify Create A Fulfillment For The Specified Order And Line Items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2020-07" }, { "info": { "name": "Shopify Create A Fulfillment For The Specified Order And Line Items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2020-10" }, { "info": { "name": "Shopify Create A Fulfillment For The Specified Order And Line Items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2021-01" }, { "info": { "name": "Shopify Create A Fulfillment For The Specified Order And Line Items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-unstable" }, { "info": { "name": "Shopify To Create A Fulfillment Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#create-2020-01" }, { "info": { "name": "Shopify To Create A Fulfillment Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#create-2020-04" }, { "info": { "name": "Shopify To Create A Fulfillment Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#create-2020-07" }, { "info": { "name": "Shopify To Create A Fulfillment Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#create-2020-10" }, { "info": { "name": "Shopify To Create A Fulfillment Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#create-2021-01" }, { "info": { "name": "Shopify To Create A Fulfillment Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#create-unstable" } ] }, { "info": { "name": "Get", "type": "folder" }, "items": [ { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "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/products/product-image#show-2020-01" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "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/products/product-image#show-2020-04" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "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/products/product-image#show-2020-07" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "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/products/product-image#show-2020-10" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "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/products/product-image#show-2021-01" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "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/products/product-image#show-unstable" }, { "info": { "name": "Shopify Get Tracking Numbers For Orders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/fetch_tracking_numbers", "params": [ { "name": "order_names", "value": "", "type": "query", "description": "The fulfillment names we require tracking numbers for (i.e. #1001.1)" }, { "name": "shop", "value": "", "type": "query", "description": "The shop's myshopify url" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#fetch-tracking-numbers" }, { "info": { "name": "Shopify Get Inventory Levels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/fetch_stock", "params": [ { "name": "max_retries", "value": "", "type": "query", "description": "The maximum amount of times Shopify will send the request for inventory levels." }, { "name": "shop", "value": "", "type": "query", "description": "The shop's myshopify url." }, { "name": "sku", "value": "", "type": "query", "description": "The SKU for the Product Variant we need stock levels for." }, { "name": "timestamp", "value": "", "type": "query", "description": "The Unix timestamp from when the inventory request was made." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#fetch-stock" } ] }, { "info": { "name": "Summaries", "type": "folder" }, "items": [ { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-2020-01" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-2020-04" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-2020-07" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-2020-10" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-2021-01" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-unstable" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_services.json", "params": [ { "name": "scope", "value": "", "type": "query", "description": "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n all: Returns all the fulfillment providers" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2020-01" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2020-01" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2020-01" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2020-01" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_services.json", "params": [ { "name": "scope", "value": "", "type": "query", "description": "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n all: Returns all the fulfillment providers" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2020-04" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2020-04" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2020-04" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2020-04" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_services.json", "params": [ { "name": "scope", "value": "", "type": "query", "description": "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n all: Returns all the fulfillment providers" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2020-07" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2020-07" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2020-07" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2020-07" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_services.json", "params": [ { "name": "scope", "value": "", "type": "query", "description": "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n all: Returns all the fulfillment providers" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2020-10" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2020-10" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2020-10" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2020-10" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_services.json", "params": [ { "name": "scope", "value": "", "type": "query", "description": "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n all: Returns all the fulfillment providers" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2021-01" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2021-01" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2021-01" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2021-01" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_services.json", "params": [ { "name": "scope", "value": "", "type": "query", "description": "current_client: Returns fulfillment providers that have been created by the app sending the request (default)\n all: Returns all the fulfillment providers" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-unstable" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-unstable" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-unstable" }, { "info": { "name": "Shopify Needs a summary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_services/:fulfillment_service_id.json", "params": [ { "name": "fulfillment_service_id", "value": "", "type": "path", "description": "fulfillment_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-unstable" } ] }, { "info": { "name": "Available", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "Published", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieve Product_ids That Are Published To A Collection_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/collection_listings/:collection_listing_id/product_ids.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-2020-01" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To A Collection_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/collection_listings/:collection_listing_id/product_ids.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-2020-04" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To A Collection_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/collection_listings/:collection_listing_id/product_ids.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-2020-07" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To A Collection_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/collection_listings/:collection_listing_id/product_ids.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-2020-10" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To A Collection_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/collection_listings/:collection_listing_id/product_ids.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-2021-01" }, { "info": { "name": "Shopify Retrieve Product_ids That Are Published To A Collection_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/collection_listings/:collection_listing_id/product_ids.json", "params": [ { "name": "collection_listing_id", "value": "", "type": "path", "description": "collection_listing_id" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-unstable" } ] }, { "info": { "name": "Fulfillment", "type": "folder" }, "items": [ { "info": { "name": "Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/cancellation_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2020-01" }, { "info": { "name": "Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/cancellation_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2020-01" }, { "info": { "name": "Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/cancellation_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2020-01" }, { "info": { "name": "Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/cancellation_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2020-04" }, { "info": { "name": "Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/cancellation_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2020-04" }, { "info": { "name": "Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/cancellation_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2020-04" }, { "info": { "name": "Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/cancellation_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2020-07" }, { "info": { "name": "Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/cancellation_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2020-07" }, { "info": { "name": "Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/cancellation_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2020-07" }, { "info": { "name": "Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/cancellation_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2020-10" }, { "info": { "name": "Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/cancellation_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2020-10" }, { "info": { "name": "Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/cancellation_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2020-10" }, { "info": { "name": "Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/cancellation_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2021-01" }, { "info": { "name": "Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/cancellation_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2021-01" }, { "info": { "name": "Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/cancellation_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2021-01" }, { "info": { "name": "Shopify Sends A Cancellation Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/cancellation_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-unstable" }, { "info": { "name": "Shopify Accepts A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/cancellation_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-unstable" }, { "info": { "name": "Shopify Rejects A Cancellation Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/cancellation_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the cancellation request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-unstable" }, { "info": { "name": "Shopify Retrieve A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "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/shipping-and-fulfillment/fulfillment#show-2020-01" }, { "info": { "name": "Shopify Creates A Fulfillment For One Or Many Fulfillment Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillments.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#createV2-2020-01" }, { "info": { "name": "Shopify Updates The Tracking Information For A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillments/:fulfillment_id/update_tracking.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2020-01" }, { "info": { "name": "Shopify Mark A Fulfillment As Open", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/fulfillments/:fulfillment_id/open.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#open-2020-01" }, { "info": { "name": "Shopify Retrieve A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "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/shipping-and-fulfillment/fulfillment#show-2020-04" }, { "info": { "name": "Shopify Creates A Fulfillment For One Or Many Fulfillment Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillments.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#createV2-2020-04" }, { "info": { "name": "Shopify Updates The Tracking Information For A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillments/:fulfillment_id/update_tracking.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2020-04" }, { "info": { "name": "Shopify Mark A Fulfillment As Open", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/fulfillments/:fulfillment_id/open.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#open-2020-04" }, { "info": { "name": "Shopify Retrieve A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "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/shipping-and-fulfillment/fulfillment#show-2020-07" }, { "info": { "name": "Shopify Creates A Fulfillment For One Or Many Fulfillment Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillments.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#createV2-2020-07" }, { "info": { "name": "Shopify Updates The Tracking Information For A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillments/:fulfillment_id/update_tracking.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2020-07" }, { "info": { "name": "Shopify Mark A Fulfillment As Open", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/fulfillments/:fulfillment_id/open.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#open-2020-07" }, { "info": { "name": "Shopify Retrieve A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "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/shipping-and-fulfillment/fulfillment#show-2020-10" }, { "info": { "name": "Shopify Creates A Fulfillment For One Or Many Fulfillment Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillments.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#createV2-2020-10" }, { "info": { "name": "Shopify Updates The Tracking Information For A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillments/:fulfillment_id/update_tracking.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2020-10" }, { "info": { "name": "Shopify Mark A Fulfillment As Open", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/fulfillments/:fulfillment_id/open.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#open-2020-10" }, { "info": { "name": "Shopify Retrieve A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "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/shipping-and-fulfillment/fulfillment#show-2021-01" }, { "info": { "name": "Shopify Creates A Fulfillment For One Or Many Fulfillment Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillments.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#createV2-2021-01" }, { "info": { "name": "Shopify Updates The Tracking Information For A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillments/:fulfillment_id/update_tracking.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2021-01" }, { "info": { "name": "Shopify Mark A Fulfillment As Open", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/fulfillments/:fulfillment_id/open.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#open-2021-01" }, { "info": { "name": "Shopify Retrieve A Specific Fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" }, { "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/shipping-and-fulfillment/fulfillment#show-unstable" }, { "info": { "name": "Shopify Creates A Fulfillment For One Or Many Fulfillment Orders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillments.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#createV2-unstable" }, { "info": { "name": "Shopify Updates The Tracking Information For A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillments/:fulfillment_id/update_tracking.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-unstable" }, { "info": { "name": "Shopify Mark A Fulfillment As Open", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/fulfillments/:fulfillment_id/open.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#open-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Specific Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-01" }, { "info": { "name": "Shopify Marks A Fulfillment Order As Cancelled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/cancel.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2020-01" }, { "info": { "name": "Shopify Marks An In Progress Fulfillment Order As Incomplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/close.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for marking the fulfillment order as incomplete." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Specific Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-04" }, { "info": { "name": "Shopify Marks A Fulfillment Order As Cancelled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/cancel.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2020-04" }, { "info": { "name": "Shopify Marks An In Progress Fulfillment Order As Incomplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/close.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for marking the fulfillment order as incomplete." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Specific Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-07" }, { "info": { "name": "Shopify Marks A Fulfillment Order As Cancelled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/cancel.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2020-07" }, { "info": { "name": "Shopify Marks An In Progress Fulfillment Order As Incomplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/close.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for marking the fulfillment order as incomplete." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Specific Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-10" }, { "info": { "name": "Shopify Marks A Fulfillment Order As Cancelled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/cancel.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2020-10" }, { "info": { "name": "Shopify Marks An In Progress Fulfillment Order As Incomplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/close.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for marking the fulfillment order as incomplete." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Specific Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2021-01" }, { "info": { "name": "Shopify Marks A Fulfillment Order As Cancelled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/cancel.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2021-01" }, { "info": { "name": "Shopify Marks An In Progress Fulfillment Order As Incomplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/close.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for marking the fulfillment order as incomplete." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2021-01" }, { "info": { "name": "Shopify Marks A Scheduled Fulfillment Order As Ready For Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/open.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#open-2021-01" }, { "info": { "name": "Shopify Updates The Fulfill_at Time Of A Scheduled Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/reschedule.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#reschedule-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Fulfillment Orders For A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Specific Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-unstable" }, { "info": { "name": "Shopify Marks A Fulfillment Order As Cancelled", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/cancel.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-unstable" }, { "info": { "name": "Shopify Releases The Fulfillment Order Holds For A Specific Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/release_hold.json", "params": [ { "name": "order_id", "value": "", "type": "query", "description": "The ID of the order that is associated to the fulfillment orders." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#release_hold-unstable" }, { "info": { "name": "Shopify Marks An In Progress Fulfillment Order As Incomplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/close.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for marking the fulfillment order as incomplete." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-unstable" }, { "info": { "name": "Shopify Marks A Scheduled Fulfillment Order As Ready For Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/open.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#open-unstable" }, { "info": { "name": "Shopify Updates The Fulfill_at Time Of A Scheduled Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/reschedule.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#reschedule-unstable" }, { "info": { "name": "Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/fulfillment_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional message for the fulfillment request." }, { "name": "fulfillment_order_line_items", "value": "", "type": "query", "description": "The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2020-01" }, { "info": { "name": "Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/fulfillment_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2020-01" }, { "info": { "name": "Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/fulfillment_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2020-01" }, { "info": { "name": "Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/fulfillment_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional message for the fulfillment request." }, { "name": "fulfillment_order_line_items", "value": "", "type": "query", "description": "The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2020-04" }, { "info": { "name": "Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/fulfillment_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2020-04" }, { "info": { "name": "Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/fulfillment_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2020-04" }, { "info": { "name": "Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/fulfillment_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional message for the fulfillment request." }, { "name": "fulfillment_order_line_items", "value": "", "type": "query", "description": "The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2020-07" }, { "info": { "name": "Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/fulfillment_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2020-07" }, { "info": { "name": "Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/fulfillment_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2020-07" }, { "info": { "name": "Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/fulfillment_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional message for the fulfillment request." }, { "name": "fulfillment_order_line_items", "value": "", "type": "query", "description": "The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2020-10" }, { "info": { "name": "Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/fulfillment_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2020-10" }, { "info": { "name": "Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/fulfillment_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2020-10" }, { "info": { "name": "Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/fulfillment_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional message for the fulfillment request." }, { "name": "fulfillment_order_line_items", "value": "", "type": "query", "description": "The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2021-01" }, { "info": { "name": "Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/fulfillment_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2021-01" }, { "info": { "name": "Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/fulfillment_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2021-01" }, { "info": { "name": "Shopify Sends A Fulfillment Request To The Fulfillment Service Of A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/fulfillment_request.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional message for the fulfillment request." }, { "name": "fulfillment_order_line_items", "value": "", "type": "query", "description": "The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-unstable" }, { "info": { "name": "Shopify Accepts A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/fulfillment_request/accept.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for accepting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-unstable" }, { "info": { "name": "Shopify Rejects A Fulfillment Request Sent To A Fulfillment Service For A Fulfillment Order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/fulfillment_request/reject.json", "params": [ { "name": "fulfillment_order_id", "value": "", "type": "path", "description": "fulfillment_order_id" }, { "name": "message", "value": "", "type": "query", "description": "An optional reason for rejecting the fulfillment request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "Carrier", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Carrier Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/carrier_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-01" }, { "info": { "name": "Shopify Updates A Carrier Service", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#update-2020-01" }, { "info": { "name": "Shopify Deletes A Carrier Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#destroy-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Carrier Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/carrier_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-04" }, { "info": { "name": "Shopify Updates A Carrier Service", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#update-2020-04" }, { "info": { "name": "Shopify Deletes A Carrier Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#destroy-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Carrier Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/carrier_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-07" }, { "info": { "name": "Shopify Updates A Carrier Service", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#update-2020-07" }, { "info": { "name": "Shopify Deletes A Carrier Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Carrier Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/carrier_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-10" }, { "info": { "name": "Shopify Updates A Carrier Service", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#update-2020-10" }, { "info": { "name": "Shopify Deletes A Carrier Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#destroy-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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 Creates A Carrier Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/carrier_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2021-01" }, { "info": { "name": "Shopify Updates A Carrier Service", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#update-2021-01" }, { "info": { "name": "Shopify Deletes A Carrier Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#destroy-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Carrier Services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/carrier_services.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-unstable" }, { "info": { "name": "Shopify Creates A Carrier Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/carrier_services.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-unstable" }, { "info": { "name": "Shopify Updates A Carrier Service", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#update-unstable" }, { "info": { "name": "Shopify Deletes A Carrier Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#destroy-unstable" } ] }, { "info": { "name": "Associated", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves Fulfillments Associated With An Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show fulfillments created after 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." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the amount of results.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-01" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With A Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/fulfillment_orders/:fulfillment_order_id/fulfillments.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 that is associated with the fulfillments." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/fulfillments/count.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-01" }, { "info": { "name": "Shopify Update Information Associated With A Fulfillment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-01" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With An Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show fulfillments created after 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." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the amount of results.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-04" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With A Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/fulfillment_orders/:fulfillment_order_id/fulfillments.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 that is associated with the fulfillments." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/fulfillments/count.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-04" }, { "info": { "name": "Shopify Update Information Associated With A Fulfillment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-04" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With An Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show fulfillments created after 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." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the amount of results.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-07" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With A Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/fulfillment_orders/:fulfillment_order_id/fulfillments.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 that is associated with the fulfillments." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/fulfillments/count.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-07" }, { "info": { "name": "Shopify Update Information Associated With A Fulfillment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-07" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With An Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show fulfillments created after 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." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the amount of results.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-10" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With A Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/fulfillment_orders/:fulfillment_order_id/fulfillments.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 that is associated with the fulfillments." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/fulfillments/count.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-10" }, { "info": { "name": "Shopify Update Information Associated With A Fulfillment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-10" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With An Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show fulfillments created after 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." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the amount of results.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2021-01" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With A Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/fulfillment_orders/:fulfillment_order_id/fulfillments.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 that is associated with the fulfillments." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/fulfillments/count.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2021-01" }, { "info": { "name": "Shopify Update Information Associated With A Fulfillment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2021-01" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With An Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/fulfillments.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show fulfillments created after 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." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the amount of results.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-unstable" }, { "info": { "name": "Shopify Retrieves Fulfillments Associated With A Fulfillment Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/fulfillment_orders/:fulfillment_order_id/fulfillments.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 that is associated with the fulfillments." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/fulfillments/count.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "created_at_max", "value": "", "type": "query", "description": "Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00)." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-unstable" }, { "info": { "name": "Shopify Update Information Associated With A Fulfillment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/fulfillments/:fulfillment_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-unstable" } ] }, { "info": { "name": "Complete", "type": "folder" }, "items": [ { "info": { "name": "Shopify Mark A Fulfillment As Complete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/fulfillments/:fulfillment_id/complete.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#complete-2020-01" }, { "info": { "name": "Shopify Mark A Fulfillment As Complete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/fulfillments/:fulfillment_id/complete.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#complete-2020-04" }, { "info": { "name": "Shopify Mark A Fulfillment As Complete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/fulfillments/:fulfillment_id/complete.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#complete-2020-07" }, { "info": { "name": "Shopify Mark A Fulfillment As Complete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/fulfillments/:fulfillment_id/complete.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#complete-2020-10" }, { "info": { "name": "Shopify Mark A Fulfillment As Complete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/fulfillments/:fulfillment_id/complete.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#complete-2021-01" }, { "info": { "name": "Shopify Mark A Fulfillment As Complete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/fulfillments/:fulfillment_id/complete.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#complete-unstable" } ] }, { "info": { "name": "Cancel", "type": "folder" }, "items": [ { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-01" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-04" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-07" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-10" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2021-01" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-unstable" } ] }, { "info": { "name": "Cancels", "type": "folder" }, "items": [ { "info": { "name": "Shopify Cancels A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancelV2-2020-01" }, { "info": { "name": "Shopify Cancels A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancelV2-2020-04" }, { "info": { "name": "Shopify Cancels A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancelV2-2020-07" }, { "info": { "name": "Shopify Cancels A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancelV2-2020-10" }, { "info": { "name": "Shopify Cancels A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancelV2-2021-01" }, { "info": { "name": "Shopify Cancels A Fulfillment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancelV2-unstable" } ] }, { "info": { "name": "Balance", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves The Account's Current Balance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/shopify_payments/balance.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2020-01" }, { "info": { "name": "Shopify Retrieves The Account's Current Balance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/shopify_payments/balance.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2020-04" }, { "info": { "name": "Shopify Retrieves The Account's Current Balance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/shopify_payments/balance.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2020-07" }, { "info": { "name": "Shopify Retrieves The Account's Current Balance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/shopify_payments/balance.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2020-10" }, { "info": { "name": "Shopify Retrieves The Account's Current Balance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/shopify_payments/balance.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2021-01" }, { "info": { "name": "Shopify Retrieves The Account's Current Balance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/shopify_payments/balance.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-unstable" } ] }, { "info": { "name": "Dispute", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Single Dispute By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/shopify_payments/disputes/:dispute_id.json", "params": [ { "name": "dispute_id", "value": "", "type": "path", "description": "dispute_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/dispute#show-2020-01" } ] }, { "info": { "name": "Countries", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "Versions", "type": "folder" }, "items": [ { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-01/countries.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#create-2020-01" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#update-2020-01" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-04/countries.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#create-2020-04" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#update-2020-04" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-07/countries.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#create-2020-07" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#update-2020-07" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2020-10/countries.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#create-2020-10" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#update-2020-10" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/2021-01/countries.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#create-2021-01" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#update-2021-01" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/api/unstable/countries.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#create-unstable" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#update-unstable" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-01/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#update-2020-01" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-04/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#update-2020-04" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-07/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#update-2020-07" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2020-10/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#update-2020-10" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/2021-01/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#update-2021-01" }, { "info": { "name": "Shopify As Of Version 2020-10", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/api/unstable/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#update-unstable" } ] }, { "info": { "name": "County", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Specific County", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_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#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Specific County", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_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#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Specific County", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_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#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Specific County", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_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#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Specific County", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_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#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Specific County", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_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#show-unstable" } ] }, { "info": { "name": "Country", "type": "folder" }, "items": [ { "info": { "name": "Shopify Deletes A Country", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-01/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#destroy-2020-01" }, { "info": { "name": "Shopify Deletes A Country", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-04/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#destroy-2020-04" }, { "info": { "name": "Shopify Deletes A Country", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-07/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#destroy-2020-07" }, { "info": { "name": "Shopify Deletes A Country", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2020-10/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#destroy-2020-10" }, { "info": { "name": "Shopify Deletes A Country", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/2021-01/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#destroy-2021-01" }, { "info": { "name": "Shopify Deletes A Country", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/api/unstable/countries/:country_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#destroy-unstable" }, { "info": { "name": "Shopify Retrieves A Single Province For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_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/province#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Province For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_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/province#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Province For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_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/province#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Province For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_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/province#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Province For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_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/province#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Province For A Country", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/countries/:country_id/provinces/:province_id.json", "params": [ { "name": "country_id", "value": "", "type": "path", "description": "country_id" }, { "name": "province_id", "value": "", "type": "path", "description": "province_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/province#show-unstable" } ] }, { "info": { "name": "Currencies", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Currencies Enabled On A Shop", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/admin/api/unstable/currencies.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-unstable" } ] }, { "info": { "name": "Configuration", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves The Shop's Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-01/shop.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-01" }, { "info": { "name": "Shopify Retrieves The Shop's Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-04/shop.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-04" }, { "info": { "name": "Shopify Retrieves The Shop's Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-07/shop.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-07" }, { "info": { "name": "Shopify Retrieves The Shop's Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2020-10/shop.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-10" }, { "info": { "name": "Shopify Retrieves The Shop's Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/2021-01/shop.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2021-01" }, { "info": { "name": "Shopify Retrieves The Shop's Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/api/unstable/shop.json", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-unstable" } ] } ], "bundled": true }