openapi: 3.1.0 info: title: Shopify Admin REST About Retrieves API description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date. version: 2025-01 contact: name: Shopify url: https://shopify.dev/docs/api/admin-rest email: api@shopify.com license: name: Shopify API Terms url: https://www.shopify.com/legal/api-terms x-date: '2026-03-04' servers: - url: https://{store}.myshopify.com/admin/api/2025-01 description: Shopify Admin REST API variables: store: default: my-store description: The Shopify store subdomain security: - AccessToken: [] tags: - name: Retrieves paths: /admin/api/unstable/customers/count.json: get: summary: Shopify Retrieves A Count Of All Customers description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_customers_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/customers/{customer_id}/orders.json: get: summary: Shopify Retrieves All Orders Belonging To A Customer description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#orders-unstable parameters: - in: path name: customer_id required: true schema: type: string description: customer_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_customers_param_customer_id_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/customers/{customer_id}/addresses.json: get: summary: Shopify Retrieves A List Of Addresses For A Customer description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-01 parameters: - in: path name: customer_id required: true schema: type: string description: customer_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_customers_param_customer_id_addresses x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json: get: summary: Shopify Retrieves Details A Single Customer Address description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2020-01 parameters: - in: path name: customer_id required: true schema: type: string description: customer_id - in: path name: address_id required: true schema: type: string description: address_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_customers_param_customer_id_addresses_param_address_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/customers/{customer_id}/addresses.json: get: summary: Shopify Retrieves A List Of Addresses For A Customer description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-04 parameters: - in: path name: customer_id required: true schema: type: string description: customer_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_customers_param_customer_id_addresses x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json: get: summary: Shopify Retrieves Details A Single Customer Address description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2020-04 parameters: - in: path name: customer_id required: true schema: type: string description: customer_id - in: path name: address_id required: true schema: type: string description: address_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_customers_param_customer_id_addresses_param_address_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/customers/{customer_id}/addresses.json: get: summary: Shopify Retrieves A List Of Addresses For A Customer description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-07 parameters: - in: path name: customer_id required: true schema: type: string description: customer_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_customers_param_customer_id_addresses x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json: get: summary: Shopify Retrieves Details A Single Customer Address description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2020-07 parameters: - in: path name: customer_id required: true schema: type: string description: customer_id - in: path name: address_id required: true schema: type: string description: address_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_customers_param_customer_id_addresses_param_address_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/customers/{customer_id}/addresses.json: get: summary: Shopify Retrieves A List Of Addresses For A Customer description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-10 parameters: - in: path name: customer_id required: true schema: type: string description: customer_id tags: - Retrieves responses: '200': description: '' operationId: get_customers_param_customer_id_addresses x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json: get: summary: Shopify Retrieves Details A Single Customer Address description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2020-10 parameters: - in: path name: customer_id required: true schema: type: string description: customer_id - in: path name: address_id required: true schema: type: string description: address_id tags: - Retrieves responses: '200': description: '' operationId: get_customers_param_customer_id_addresses_param_address_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/customers/{customer_id}/addresses.json: get: summary: Shopify Retrieves A List Of Addresses For A Customer description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2021-01 parameters: - in: path name: customer_id required: true schema: type: string description: customer_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_customers_param_customer_id_addresses x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json: get: summary: Shopify Retrieves Details A Single Customer Address description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2021-01 parameters: - in: path name: customer_id required: true schema: type: string description: customer_id - in: path name: address_id required: true schema: type: string description: address_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_customers_param_customer_id_addresses_param_address_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/customers/{customer_id}/addresses.json: get: summary: Shopify Retrieves A List Of Addresses For A Customer description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-unstable parameters: - in: path name: customer_id required: true schema: type: string description: customer_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_customers_param_customer_id_addresses x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json: get: summary: Shopify Retrieves Details A Single Customer Address description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-unstable parameters: - in: path name: customer_id required: true schema: type: string description: customer_id - in: path name: address_id required: true schema: type: string description: address_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_customers_param_customer_id_addresses_param_address_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/customer_saved_searches.json: get: summary: Shopify Retrieves A List Of Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-01 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_customer_saved_searches x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/customer_saved_searches/count.json: get: summary: Shopify Retrieves A Count Of All Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-01 parameters: - in: query name: since_id description: Restrict results to after the specified ID schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_customer_saved_searches_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json: get: summary: Shopify Retrieves A Single Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2020-01 parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_customer_saved_searches_param_customer_saved_search_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}/customers.json: get: summary: Shopify Retrieves All Customers Returned By A Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2020-01 parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: order description: "Set the field and direction by which to order results.\n (default: last_order_date DESC)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_customer_saved_searches_param_customer_saved_search_id_customers x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/customer_saved_searches.json: get: summary: Shopify Retrieves A List Of Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-04 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_customer_saved_searches x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/customer_saved_searches/count.json: get: summary: Shopify Retrieves A Count Of All Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-04 parameters: - in: query name: since_id description: Restrict results to after the specified ID schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_customer_saved_searches_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json: get: summary: Shopify Retrieves A Single Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2020-04 parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_customer_saved_searches_param_customer_saved_search_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}/customers.json: get: summary: Shopify Retrieves All Customers Returned By A Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2020-04 parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: order description: "Set the field and direction by which to order results.\n (default: last_order_date DESC)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_customer_saved_searches_param_customer_saved_search_id_customers x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/customer_saved_searches.json: get: summary: Shopify Retrieves A List Of Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-07 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_customer_saved_searches x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/customer_saved_searches/count.json: get: summary: Shopify Retrieves A Count Of All Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-07 parameters: - in: query name: since_id description: Restrict results to after the specified ID schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_customer_saved_searches_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json: get: summary: Shopify Retrieves A Single Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2020-07 parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_customer_saved_searches_param_customer_saved_search_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}/customers.json: get: summary: Shopify Retrieves All Customers Returned By A Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2020-07 parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: order description: "Set the field and direction by which to order results.\n (default: last_order_date DESC)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_customer_saved_searches_param_customer_saved_search_id_customers x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/customer_saved_searches.json: get: summary: Shopify Retrieves A List Of Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-10 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_customer_saved_searches x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/customer_saved_searches/count.json: get: summary: Shopify Retrieves A Count Of All Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-10 parameters: - in: query name: since_id description: Restrict results to after the specified ID schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_customer_saved_searches_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json: get: summary: Shopify Retrieves A Single Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2020-10 parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_customer_saved_searches_param_customer_saved_search_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}/customers.json: get: summary: Shopify Retrieves All Customers Returned By A Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2020-10 parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: order description: "Set the field and direction by which to order results.\n (default: last_order_date DESC)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_customer_saved_searches_param_customer_saved_search_id_customers x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/customer_saved_searches.json: get: summary: Shopify Retrieves A List Of Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2021-01 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_customer_saved_searches x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/customer_saved_searches/count.json: get: summary: Shopify Retrieves A Count Of All Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2021-01 parameters: - in: query name: since_id description: Restrict results to after the specified ID schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_customer_saved_searches_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json: get: summary: Shopify Retrieves A Single Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2021-01 parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_customer_saved_searches_param_customer_saved_search_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}/customers.json: get: summary: Shopify Retrieves All Customers Returned By A Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2021-01 parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: order description: "Set the field and direction by which to order results.\n (default: last_order_date DESC)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_customer_saved_searches_param_customer_saved_search_id_customers x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/customer_saved_searches.json: get: summary: Shopify Retrieves A List Of Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-unstable parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_customer_saved_searches x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/customer_saved_searches/count.json: get: summary: Shopify Retrieves A Count Of All Customer Saved Searches description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-unstable parameters: - in: query name: since_id description: Restrict results to after the specified ID schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_customer_saved_searches_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.json: get: summary: Shopify Retrieves A Single Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-unstable parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_customer_saved_searches_param_customer_saved_search_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/customer_saved_searches/{customer_saved_search_id}/customers.json: get: summary: Shopify Retrieves All Customers Returned By A Customer Saved Search description: https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-unstable parameters: - in: path name: customer_saved_search_id required: true schema: type: string description: customer_saved_search_id - in: query name: order description: "Set the field and direction by which to order results.\n (default: last_order_date DESC)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_customer_saved_searches_param_customer_saved_search_id_customers x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/deprecated_api_calls.json: get: summary: Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days description: https://shopify.dev/docs/admin-api/rest/reference/deprecated_api_calls#index-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_deprecated_api_calls x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/deprecated_api_calls.json: get: summary: Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated Private App In The Past 30 Days description: https://shopify.dev/docs/admin-api/rest/reference/deprecated_api_calls#index-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_deprecated_api_calls x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/price_rules/{price_rule_id}/discount_codes.json: get: summary: Shopify Retrieve A List Of Discount Codes description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2020-01 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_price_rules_param_price_rule_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json: get: summary: Shopify Retrieves A Single Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2020-01 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: discount_code_id required: true schema: type: string description: discount_code_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_price_rules_param_price_rule_id_discount_codes_param_discount_code_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/discount_codes/lookup.json: get: summary: Shopify Retrieves The Location Of A Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2020-01 parameters: - in: query name: code schema: type: integer description: code required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_discount_codes_lookup x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}.json: get: summary: Shopify Retrieves A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-01 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_price_rules_param_price_rule_id_batch_param_batch_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json: get: summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-01 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/price_rules/{price_rule_id}/discount_codes.json: get: summary: Shopify Retrieve A List Of Discount Codes description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2020-04 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_price_rules_param_price_rule_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json: get: summary: Shopify Retrieves A Single Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2020-04 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: discount_code_id required: true schema: type: string description: discount_code_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_price_rules_param_price_rule_id_discount_codes_param_discount_code_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/discount_codes/lookup.json: get: summary: Shopify Retrieves The Location Of A Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2020-04 parameters: - in: query name: code schema: type: integer description: code required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_discount_codes_lookup x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}.json: get: summary: Shopify Retrieves A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-04 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_price_rules_param_price_rule_id_batch_param_batch_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json: get: summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-04 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/price_rules/{price_rule_id}/discount_codes.json: get: summary: Shopify Retrieve A List Of Discount Codes description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2020-07 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_price_rules_param_price_rule_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json: get: summary: Shopify Retrieves A Single Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2020-07 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: discount_code_id required: true schema: type: string description: discount_code_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_price_rules_param_price_rule_id_discount_codes_param_discount_code_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/discount_codes/lookup.json: get: summary: Shopify Retrieves The Location Of A Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2020-07 parameters: - in: query name: code schema: type: integer description: code required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_discount_codes_lookup x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}.json: get: summary: Shopify Retrieves A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-07 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_price_rules_param_price_rule_id_batch_param_batch_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json: get: summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-07 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/price_rules/{price_rule_id}/discount_codes.json: get: summary: Shopify Retrieve A List Of Discount Codes description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2020-10 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id tags: - Retrieves responses: '200': description: '' operationId: get_price_rules_param_price_rule_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json: get: summary: Shopify Retrieves A Single Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2020-10 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: discount_code_id required: true schema: type: string description: discount_code_id tags: - Retrieves responses: '200': description: '' operationId: get_price_rules_param_price_rule_id_discount_codes_param_discount_code_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/discount_codes/lookup.json: get: summary: Shopify Retrieves The Location Of A Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2020-10 parameters: - in: query name: code schema: type: integer description: code required: false tags: - Retrieves responses: '200': description: '' operationId: get_discount_codes_lookup x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}.json: get: summary: Shopify Retrieves A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-10 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: get_price_rules_param_price_rule_id_batch_param_batch_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json: get: summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-10 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.json: get: summary: Shopify Retrieve A List Of Discount Codes description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2021-01 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_price_rules_param_price_rule_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json: get: summary: Shopify Retrieves A Single Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2021-01 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: discount_code_id required: true schema: type: string description: discount_code_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_price_rules_param_price_rule_id_discount_codes_param_discount_code_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/discount_codes/lookup.json: get: summary: Shopify Retrieves The Location Of A Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2021-01 parameters: - in: query name: code schema: type: integer description: code required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_discount_codes_lookup x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}.json: get: summary: Shopify Retrieves A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2021-01 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_price_rules_param_price_rule_id_batch_param_batch_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json: get: summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2021-01 parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/price_rules/{price_rule_id}/discount_codes.json: get: summary: Shopify Retrieve A List Of Discount Codes description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-unstable parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_price_rules_param_price_rule_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json: get: summary: Shopify Retrieves A Single Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-unstable parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: discount_code_id required: true schema: type: string description: discount_code_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_price_rules_param_price_rule_id_discount_codes_param_discount_code_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/discount_codes/lookup.json: get: summary: Shopify Retrieves The Location Of A Discount Code description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-unstable parameters: - in: query name: code schema: type: integer description: code required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_discount_codes_lookup x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}.json: get: summary: Shopify Retrieves A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-unstable parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_price_rules_param_price_rule_id_batch_param_batch_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json: get: summary: Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job description: https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-unstable parameters: - in: path name: price_rule_id required: true schema: type: string description: price_rule_id - in: path name: batch_id required: true schema: type: string description: batch_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_price_rules_param_price_rule_id_batch_param_batch_id_discount_codes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/events.json: get: summary: Shopify Retrieves A List Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2020-01 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Show only results after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: filter description: Show events specified in this filter. schema: {} required: false - in: query name: verb description: Show events of a certain type. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/events/{event_id}.json: get: summary: Shopify Retrieves A Single Event By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2020-01 parameters: - in: path name: event_id required: true schema: type: string description: event_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/events/count.json: get: summary: Shopify Retrieves A Count Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2020-01 parameters: - in: query name: created_at_min description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_events_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/events.json: get: summary: Shopify Retrieves A List Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2020-04 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Show only results after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: filter description: Show events specified in this filter. schema: {} required: false - in: query name: verb description: Show events of a certain type. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/events/{event_id}.json: get: summary: Shopify Retrieves A Single Event By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2020-04 parameters: - in: path name: event_id required: true schema: type: string description: event_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/events/count.json: get: summary: Shopify Retrieves A Count Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2020-04 parameters: - in: query name: created_at_min description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_events_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/events.json: get: summary: Shopify Retrieves A List Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2020-07 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Show only results after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: filter description: Show events specified in this filter. schema: {} required: false - in: query name: verb description: Show events of a certain type. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/events/{event_id}.json: get: summary: Shopify Retrieves A Single Event By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2020-07 parameters: - in: path name: event_id required: true schema: type: string description: event_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/events/count.json: get: summary: Shopify Retrieves A Count Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2020-07 parameters: - in: query name: created_at_min description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_events_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/events.json: get: summary: Shopify Retrieves A List Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2020-10 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Show only results after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: filter description: Show events specified in this filter. schema: {} required: false - in: query name: verb description: Show events of a certain type. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/events/{event_id}.json: get: summary: Shopify Retrieves A Single Event By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2020-10 parameters: - in: path name: event_id required: true schema: type: string description: event_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/events/count.json: get: summary: Shopify Retrieves A Count Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2020-10 parameters: - in: query name: created_at_min description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_events_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/events.json: get: summary: Shopify Retrieves A List Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2021-01 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Show only results after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: filter description: Show events specified in this filter. schema: {} required: false - in: query name: verb description: Show events of a certain type. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/events/{event_id}.json: get: summary: Shopify Retrieves A Single Event By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2021-01 parameters: - in: path name: event_id required: true schema: type: string description: event_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/events/count.json: get: summary: Shopify Retrieves A Count Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2021-01 parameters: - in: query name: created_at_min description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_events_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/events.json: get: summary: Shopify Retrieves A List Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#index-unstable parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Show only results after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: filter description: Show events specified in this filter. schema: {} required: false - in: query name: verb description: Show events of a certain type. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/events/{event_id}.json: get: summary: Shopify Retrieves A Single Event By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/events/event#show-unstable parameters: - in: path name: event_id required: true schema: type: string description: event_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/events/count.json: get: summary: Shopify Retrieves A Count Of Events description: https://shopify.dev/docs/admin-api/rest/reference/events/event#count-unstable parameters: - in: query name: created_at_min description: 'Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_events_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/webhooks.json: get: summary: Shopify Retrieves A List Of Webhooks description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-01 parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: created_at_max description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields 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. schema: {} required: false - in: query name: limit 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)" schema: {} required: false - in: query name: since_id description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false - in: query name: updated_at_min description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_webhooks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/webhooks/count.json: get: summary: Shopify Retrieves A Count Of Existing Webhook Subscriptions description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-01 parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_webhooks_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/webhooks/{webhook_id}.json: get: summary: Shopify Retrieves A Single Webhook Subscription description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-01 parameters: - in: path name: webhook_id required: true schema: type: string description: webhook_id - in: query name: fields 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_webhooks_param_webhook_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/webhooks.json: get: summary: Shopify Retrieves A List Of Webhooks description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-04 parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: created_at_max description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields 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. schema: {} required: false - in: query name: limit 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)" schema: {} required: false - in: query name: since_id description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false - in: query name: updated_at_min description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_webhooks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/webhooks/count.json: get: summary: Shopify Retrieves A Count Of Existing Webhook Subscriptions description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-04 parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_webhooks_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/webhooks/{webhook_id}.json: get: summary: Shopify Retrieves A Single Webhook Subscription description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-04 parameters: - in: path name: webhook_id required: true schema: type: string description: webhook_id - in: query name: fields 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_webhooks_param_webhook_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/webhooks.json: get: summary: Shopify Retrieves A List Of Webhooks description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-07 parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: created_at_max description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields 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. schema: {} required: false - in: query name: limit 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)" schema: {} required: false - in: query name: since_id description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false - in: query name: updated_at_min description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_webhooks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/webhooks/count.json: get: summary: Shopify Retrieves A Count Of Existing Webhook Subscriptions description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-07 parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_webhooks_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/webhooks/{webhook_id}.json: get: summary: Shopify Retrieves A Single Webhook Subscription description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-07 parameters: - in: path name: webhook_id required: true schema: type: string description: webhook_id - in: query name: fields 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_webhooks_param_webhook_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/webhooks.json: get: summary: Shopify Retrieves A List Of Webhooks description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-10 parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: created_at_max description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields 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. schema: {} required: false - in: query name: limit 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)" schema: {} required: false - in: query name: since_id description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false - in: query name: updated_at_min description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_webhooks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/webhooks/count.json: get: summary: Shopify Retrieves A Count Of Existing Webhook Subscriptions description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-10 parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_webhooks_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/webhooks/{webhook_id}.json: get: summary: Shopify Retrieves A Single Webhook Subscription description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-10 parameters: - in: path name: webhook_id required: true schema: type: string description: webhook_id - in: query name: fields 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_webhooks_param_webhook_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/webhooks.json: get: summary: Shopify Retrieves A List Of Webhooks description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2021-01 parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: created_at_max description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields 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. schema: {} required: false - in: query name: limit 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)" schema: {} required: false - in: query name: since_id description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false - in: query name: updated_at_min description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_webhooks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/webhooks/count.json: get: summary: Shopify Retrieves A Count Of Existing Webhook Subscriptions description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2021-01 parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_webhooks_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/webhooks/{webhook_id}.json: get: summary: Shopify Retrieves A Single Webhook Subscription description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2021-01 parameters: - in: path name: webhook_id required: true schema: type: string description: webhook_id - in: query name: fields 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_webhooks_param_webhook_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/webhooks.json: get: summary: Shopify Retrieves A List Of Webhooks description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-unstable parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: created_at_max description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields 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. schema: {} required: false - in: query name: limit 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)" schema: {} required: false - in: query name: since_id description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false - in: query name: updated_at_min description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_webhooks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/webhooks/count.json: get: summary: Shopify Retrieves A Count Of Existing Webhook Subscriptions description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-unstable parameters: - in: query name: address description: Retrieve webhook subscriptions that send the POST request to this URI. schema: {} required: false - in: query name: topic description: 'Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_webhooks_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/webhooks/{webhook_id}.json: get: summary: Shopify Retrieves A Single Webhook Subscription description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-unstable parameters: - in: path name: webhook_id required: true schema: type: string description: webhook_id - in: query name: fields 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_webhooks_param_webhook_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-01 parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/inventory_items/{inventory_item_id}.json: get: summary: Shopify Retrieves A Single Inventory Item By Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-01 parameters: - in: path name: inventory_item_id required: true schema: type: string description: inventory_item_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_inventory_items_param_inventory_item_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-04 parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/inventory_items/{inventory_item_id}.json: get: summary: Shopify Retrieves A Single Inventory Item By Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-04 parameters: - in: path name: inventory_item_id required: true schema: type: string description: inventory_item_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_inventory_items_param_inventory_item_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-07 parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/inventory_items/{inventory_item_id}.json: get: summary: Shopify Retrieves A Single Inventory Item By Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-07 parameters: - in: path name: inventory_item_id required: true schema: type: string description: inventory_item_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_inventory_items_param_inventory_item_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-10 parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Retrieves responses: '200': description: '' operationId: get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/inventory_items/{inventory_item_id}.json: get: summary: Shopify Retrieves A Single Inventory Item By Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-10 parameters: - in: path name: inventory_item_id required: true schema: type: string description: inventory_item_id tags: - Retrieves responses: '200': description: '' operationId: get_inventory_items_param_inventory_item_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2021-01 parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/inventory_items/{inventory_item_id}.json: get: summary: Shopify Retrieves A Single Inventory Item By Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2021-01 parameters: - in: path name: inventory_item_id required: true schema: type: string description: inventory_item_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_inventory_items_param_inventory_item_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/inventory_items.json: get: summary: Shopify Retrieves A List Of Inventory Items description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-unstable parameters: - in: query name: "ids\n required" description: "Show only inventory items specified by a comma-separated list of IDs.\n (maximum: 100)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids schema: type: integer description: ids required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_inventory_items x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/inventory_items/{inventory_item_id}.json: get: summary: Shopify Retrieves A Single Inventory Item By Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-unstable parameters: - in: path name: inventory_item_id required: true schema: type: string description: inventory_item_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_inventory_items_param_inventory_item_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2020-01 parameters: - in: query name: inventory_item_ids description: "A comma-separated list of inventory item IDs.\n (maximum: 50)" schema: {} required: false - in: query name: location_ids description: "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: updated_at_min description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2020-04 parameters: - in: query name: inventory_item_ids description: "A comma-separated list of inventory item IDs.\n (maximum: 50)" schema: {} required: false - in: query name: location_ids description: "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: updated_at_min description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2020-07 parameters: - in: query name: inventory_item_ids description: "A comma-separated list of inventory item IDs.\n (maximum: 50)" schema: {} required: false - in: query name: location_ids description: "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: updated_at_min description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2020-10 parameters: - in: query name: inventory_item_ids description: "A comma-separated list of inventory item IDs.\n (maximum: 50)" schema: {} required: false - in: query name: location_ids description: "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: updated_at_min description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2021-01 parameters: - in: query name: inventory_item_ids description: "A comma-separated list of inventory item IDs.\n (maximum: 50)" schema: {} required: false - in: query name: location_ids description: "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: updated_at_min description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels description: https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-unstable parameters: - in: query name: inventory_item_ids description: "A comma-separated list of inventory item IDs.\n (maximum: 50)" schema: {} required: false - in: query name: location_ids description: "A comma-separated list of location IDs. To find the ID of a location, use the Location resource.\n (maximum: 50)" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: updated_at_min description: 'Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/locations.json: get: summary: Shopify Retrieves A List Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_locations x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/locations/{location_id}.json: get: summary: Shopify Retrieves A Single Location By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-01 parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_locations_param_location_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/locations/count.json: get: summary: Shopify Retrieves A Count Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_locations_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/locations/{location_id}/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels For A Location description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2020-01 parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_locations_param_location_id_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/locations.json: get: summary: Shopify Retrieves A List Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_locations x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/locations/{location_id}.json: get: summary: Shopify Retrieves A Single Location By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-04 parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_locations_param_location_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/locations/count.json: get: summary: Shopify Retrieves A Count Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_locations_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/locations/{location_id}/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels For A Location description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2020-04 parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_locations_param_location_id_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/locations.json: get: summary: Shopify Retrieves A List Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_locations x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/locations/{location_id}.json: get: summary: Shopify Retrieves A Single Location By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-07 parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_locations_param_location_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/locations/count.json: get: summary: Shopify Retrieves A Count Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_locations_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/locations/{location_id}/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels For A Location description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2020-07 parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_locations_param_location_id_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/locations.json: get: summary: Shopify Retrieves A List Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2020-10 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: get_locations x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/locations/{location_id}.json: get: summary: Shopify Retrieves A Single Location By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-10 parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: get_locations_param_location_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/locations/count.json: get: summary: Shopify Retrieves A Count Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2020-10 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: get_locations_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/locations/{location_id}/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels For A Location description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2020-10 parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: get_locations_param_location_id_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/locations.json: get: summary: Shopify Retrieves A List Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_locations x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/locations/{location_id}.json: get: summary: Shopify Retrieves A Single Location By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2021-01 parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_locations_param_location_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/locations/count.json: get: summary: Shopify Retrieves A Count Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_locations_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/locations/{location_id}/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels For A Location description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2021-01 parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_locations_param_location_id_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/locations.json: get: summary: Shopify Retrieves A List Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_locations x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/locations/{location_id}.json: get: summary: Shopify Retrieves A Single Location By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-unstable parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_locations_param_location_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/locations/count.json: get: summary: Shopify Retrieves A Count Of Locations description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_locations_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/locations/{location_id}/inventory_levels.json: get: summary: Shopify Retrieves A List Of Inventory Levels For A Location description: https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-unstable parameters: - in: path name: location_id required: true schema: type: string description: location_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_locations_param_location_id_inventory_levels x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/metafields.json: get: summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-01 parameters: - in: query name: metafield[owner_id] schema: type: integer description: metafield[owner_id] required: false - in: query name: metafield[owner_resource] schema: type: string description: metafield[owner_resource] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_metafields x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/metafields/count.json: get: summary: Shopify Retrieves A Count Of A Resource's Metafields description: https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_metafields_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/metafields/{metafield_id}.json: get: summary: Shopify Retrieves A Single Metafield From A Resource By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-01 parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/metafields.json: get: summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-04 parameters: - in: query name: metafield[owner_id] schema: type: integer description: metafield[owner_id] required: false - in: query name: metafield[owner_resource] schema: type: string description: metafield[owner_resource] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_metafields x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/metafields/count.json: get: summary: Shopify Retrieves A Count Of A Resource's Metafields description: https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_metafields_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/metafields/{metafield_id}.json: get: summary: Shopify Retrieves A Single Metafield From A Resource By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-04 parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/metafields.json: get: summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-07 parameters: - in: query name: metafield[owner_id] schema: type: integer description: metafield[owner_id] required: false - in: query name: metafield[owner_resource] schema: type: string description: metafield[owner_resource] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_metafields x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/metafields/count.json: get: summary: Shopify Retrieves A Count Of A Resource's Metafields description: https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_metafields_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/metafields/{metafield_id}.json: get: summary: Shopify Retrieves A Single Metafield From A Resource By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-07 parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/metafields.json: get: summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-10 parameters: - in: query name: metafield[owner_id] schema: type: integer description: metafield[owner_id] required: false - in: query name: metafield[owner_resource] schema: type: string description: metafield[owner_resource] required: false tags: - Retrieves responses: '200': description: '' operationId: get_metafields x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/metafields/count.json: get: summary: Shopify Retrieves A Count Of A Resource's Metafields description: https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2020-10 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: get_metafields_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/metafields/{metafield_id}.json: get: summary: Shopify Retrieves A Single Metafield From A Resource By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-10 parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/metafields.json: get: summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2021-01 parameters: - in: query name: metafield[owner_id] schema: type: integer description: metafield[owner_id] required: false - in: query name: metafield[owner_resource] schema: type: string description: metafield[owner_resource] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_metafields x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/metafields/count.json: get: summary: Shopify Retrieves A Count Of A Resource's Metafields description: https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_metafields_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/metafields/{metafield_id}.json: get: summary: Shopify Retrieves A Single Metafield From A Resource By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2021-01 parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/metafields.json: get: summary: Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource description: https://shopify.dev/docs/admin-api/rest/reference/metafield#index-unstable parameters: - in: query name: metafield[owner_id] schema: type: integer description: metafield[owner_id] required: false - in: query name: metafield[owner_resource] schema: type: string description: metafield[owner_resource] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_metafields x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/metafields/count.json: get: summary: Shopify Retrieves A Count Of A Resource's Metafields description: https://shopify.dev/docs/admin-api/rest/reference/metafield#count-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_metafields_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/metafields/{metafield_id}.json: get: summary: Shopify Retrieves A Single Metafield From A Resource By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#show-unstable parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/blogs/{blog_id}/articles.json: get: summary: Shopify Retrieves A List Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2020-01 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: handle description: Retrieve an article with a specific handle. schema: {} required: false - in: query name: tag description: Filter articles with a specific tag. schema: {} required: false - in: query name: author description: Filter articles by article author. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_blogs_param_blog_id_articles x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/blogs/{blog_id}/articles/count.json: get: summary: Shopify Retrieves A Count Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2020-01 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: created_at_min description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_blogs_param_blog_id_articles_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.json: get: summary: Shopify Retrieves A Single Article description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2020-01 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: path name: article_id required: true schema: type: string description: article_id - in: query name: fields description: Show only certain fields, specifed by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_blogs_param_blog_id_articles_param_article_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/articles/authors.json: get: summary: Shopify Retrieves A List All Of Article Authors description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_articles_authors x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/articles/tags.json: get: summary: Shopify Retrieves A List Of All The Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2020-01 parameters: - in: query name: limit description: The maximum number of tags to retrieve. schema: {} required: false - in: query name: popular 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_articles_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/blogs/{blog_id}/articles.json: get: summary: Shopify Retrieves A List Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2020-04 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: handle description: Retrieve an article with a specific handle. schema: {} required: false - in: query name: tag description: Filter articles with a specific tag. schema: {} required: false - in: query name: author description: Filter articles by article author. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_blogs_param_blog_id_articles x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/blogs/{blog_id}/articles/count.json: get: summary: Shopify Retrieves A Count Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2020-04 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: created_at_min description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_blogs_param_blog_id_articles_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.json: get: summary: Shopify Retrieves A Single Article description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2020-04 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: path name: article_id required: true schema: type: string description: article_id - in: query name: fields description: Show only certain fields, specifed by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_blogs_param_blog_id_articles_param_article_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/articles/authors.json: get: summary: Shopify Retrieves A List All Of Article Authors description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_articles_authors x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/articles/tags.json: get: summary: Shopify Retrieves A List Of All The Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2020-04 parameters: - in: query name: limit description: The maximum number of tags to retrieve. schema: {} required: false - in: query name: popular 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_articles_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/blogs/{blog_id}/articles.json: get: summary: Shopify Retrieves A List Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2020-07 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: handle description: Retrieve an article with a specific handle. schema: {} required: false - in: query name: tag description: Filter articles with a specific tag. schema: {} required: false - in: query name: author description: Filter articles by article author. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_blogs_param_blog_id_articles x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/blogs/{blog_id}/articles/count.json: get: summary: Shopify Retrieves A Count Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2020-07 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: created_at_min description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_blogs_param_blog_id_articles_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.json: get: summary: Shopify Retrieves A Single Article description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2020-07 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: path name: article_id required: true schema: type: string description: article_id - in: query name: fields description: Show only certain fields, specifed by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_blogs_param_blog_id_articles_param_article_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/articles/authors.json: get: summary: Shopify Retrieves A List All Of Article Authors description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_articles_authors x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/articles/tags.json: get: summary: Shopify Retrieves A List Of All The Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2020-07 parameters: - in: query name: limit description: The maximum number of tags to retrieve. schema: {} required: false - in: query name: popular 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_articles_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/blogs/{blog_id}/articles.json: get: summary: Shopify Retrieves A List Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2020-10 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: handle description: Retrieve an article with a specific handle. schema: {} required: false - in: query name: tag description: Filter articles with a specific tag. schema: {} required: false - in: query name: author description: Filter articles by article author. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_blogs_param_blog_id_articles x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/blogs/{blog_id}/articles/count.json: get: summary: Shopify Retrieves A Count Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2020-10 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: created_at_min description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_blogs_param_blog_id_articles_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.json: get: summary: Shopify Retrieves A Single Article description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2020-10 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: path name: article_id required: true schema: type: string description: article_id - in: query name: fields description: Show only certain fields, specifed by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_blogs_param_blog_id_articles_param_article_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/articles/authors.json: get: summary: Shopify Retrieves A List All Of Article Authors description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2020-10 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: get_articles_authors x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/articles/tags.json: get: summary: Shopify Retrieves A List Of All The Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2020-10 parameters: - in: query name: limit description: The maximum number of tags to retrieve. schema: {} required: false - in: query name: popular 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_articles_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/blogs/{blog_id}/articles.json: get: summary: Shopify Retrieves A List Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2021-01 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: handle description: Retrieve an article with a specific handle. schema: {} required: false - in: query name: tag description: Filter articles with a specific tag. schema: {} required: false - in: query name: author description: Filter articles by article author. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_blogs_param_blog_id_articles x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/blogs/{blog_id}/articles/count.json: get: summary: Shopify Retrieves A Count Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2021-01 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: created_at_min description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_blogs_param_blog_id_articles_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.json: get: summary: Shopify Retrieves A Single Article description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2021-01 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: path name: article_id required: true schema: type: string description: article_id - in: query name: fields description: Show only certain fields, specifed by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_blogs_param_blog_id_articles_param_article_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/articles/authors.json: get: summary: Shopify Retrieves A List All Of Article Authors description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_articles_authors x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/articles/tags.json: get: summary: Shopify Retrieves A List Of All The Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2021-01 parameters: - in: query name: limit description: The maximum number of tags to retrieve. schema: {} required: false - in: query name: popular 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_articles_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/blogs/{blog_id}/articles.json: get: summary: Shopify Retrieves A List Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-unstable parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Show articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: handle description: Retrieve an article with a specific handle. schema: {} required: false - in: query name: tag description: Filter articles with a specific tag. schema: {} required: false - in: query name: author description: Filter articles by article author. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_blogs_param_blog_id_articles x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/blogs/{blog_id}/articles/count.json: get: summary: Shopify Retrieves A Count Of All Articles From A Blog description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-unstable parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: created_at_min description: 'Count articles created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count articles created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count articles published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count articles published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_blogs_param_blog_id_articles_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/blogs/{blog_id}/articles/{article_id}.json: get: summary: Shopify Retrieves A Single Article description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-unstable parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: path name: article_id required: true schema: type: string description: article_id - in: query name: fields description: Show only certain fields, specifed by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_blogs_param_blog_id_articles_param_article_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/articles/authors.json: get: summary: Shopify Retrieves A List All Of Article Authors description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_articles_authors x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/articles/tags.json: get: summary: Shopify Retrieves A List Of All The Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-unstable parameters: - in: query name: limit description: The maximum number of tags to retrieve. schema: {} required: false - in: query name: popular 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. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_articles_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/themes/{theme_id}/assets.json: get: summary: Shopify Retrieves A Single Asset For A Theme By Its Key description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-01 parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names schema: {} required: false - in: query name: asset[key] schema: type: string description: asset[key] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_themes_param_theme_id_assets x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/themes/{theme_id}/assets.json: get: summary: Shopify Retrieves A Single Asset For A Theme By Its Key description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-04 parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names schema: {} required: false - in: query name: asset[key] schema: type: string description: asset[key] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_themes_param_theme_id_assets x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/themes/{theme_id}/assets.json: get: summary: Shopify Retrieves A Single Asset For A Theme By Its Key description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-07 parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names schema: {} required: false - in: query name: asset[key] schema: type: string description: asset[key] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_themes_param_theme_id_assets x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/themes/{theme_id}/assets.json: get: summary: Shopify Retrieves A Single Asset For A Theme By Its Key description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-10 parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names schema: {} required: false - in: query name: asset[key] schema: type: string description: asset[key] required: false tags: - Retrieves responses: '200': description: '' operationId: get_themes_param_theme_id_assets x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/themes/{theme_id}/assets.json: get: summary: Shopify Retrieves A Single Asset For A Theme By Its Key description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2021-01 parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names schema: {} required: false - in: query name: asset[key] schema: type: string description: asset[key] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_themes_param_theme_id_assets x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/themes/{theme_id}/assets.json: get: summary: Shopify Retrieves A Single Asset For A Theme By Its Key description: https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-unstable parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names schema: {} required: false - in: query name: asset[key] schema: type: string description: asset[key] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_themes_param_theme_id_assets x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/blogs.json: get: summary: Shopify Retrieve A List Of All Blogs description: https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#index-2020-01 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID schema: {} required: false - in: query name: handle description: Filter by blog handle schema: {} required: false - in: query name: fields description: comma-separated list of fields to include in the response schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_blogs x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/comments.json: get: summary: Shopify Retrieves A List Of Comments description: https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#index-2020-01 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show comments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Show comments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show comments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show comments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show comments published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show comments published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: article_id schema: type: integer description: article_id required: false - in: query name: blog_id schema: type: integer description: blog_id required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_comments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/comments/count.json: get: summary: Shopify Retrieves A Count Of Comments description: https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#count-2020-01 parameters: - in: query name: created_at_min description: 'Count comments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count comments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count comments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count comments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count comments published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count comments published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: article_id schema: type: integer description: article_id required: false - in: query name: blog_id schema: type: integer description: blog_id required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_comments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/comments/{comment_id}.json: get: summary: Shopify Retrieves A Single Comment By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#show-2020-01 parameters: - in: path name: comment_id required: true schema: type: string description: comment_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_comments_param_comment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/redirects.json: get: summary: Shopify Retrieves A List Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-01 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: path description: Show redirects with a given path. schema: {} required: false - in: query name: target description: Show redirects with a given target. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_redirects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/redirects/count.json: get: summary: Shopify Retrieves A Count Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-01 parameters: - in: query name: path description: Count redirects with given path. schema: {} required: false - in: query name: target description: Count redirects with given target. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_redirects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/redirects/{redirect_id}.json: get: summary: Shopify Retrieves A Single Redirect description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2020-01 parameters: - in: path name: redirect_id required: true schema: type: string description: redirect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_redirects_param_redirect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/redirects.json: get: summary: Shopify Retrieves A List Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-04 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: path description: Show redirects with a given path. schema: {} required: false - in: query name: target description: Show redirects with a given target. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_redirects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/redirects/count.json: get: summary: Shopify Retrieves A Count Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-04 parameters: - in: query name: path description: Count redirects with given path. schema: {} required: false - in: query name: target description: Count redirects with given target. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_redirects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/redirects/{redirect_id}.json: get: summary: Shopify Retrieves A Single Redirect description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2020-04 parameters: - in: path name: redirect_id required: true schema: type: string description: redirect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_redirects_param_redirect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/redirects.json: get: summary: Shopify Retrieves A List Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-07 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: path description: Show redirects with a given path. schema: {} required: false - in: query name: target description: Show redirects with a given target. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_redirects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/redirects/count.json: get: summary: Shopify Retrieves A Count Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-07 parameters: - in: query name: path description: Count redirects with given path. schema: {} required: false - in: query name: target description: Count redirects with given target. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_redirects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/redirects/{redirect_id}.json: get: summary: Shopify Retrieves A Single Redirect description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2020-07 parameters: - in: path name: redirect_id required: true schema: type: string description: redirect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_redirects_param_redirect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/redirects.json: get: summary: Shopify Retrieves A List Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-10 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: path description: Show redirects with a given path. schema: {} required: false - in: query name: target description: Show redirects with a given target. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_redirects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/redirects/count.json: get: summary: Shopify Retrieves A Count Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-10 parameters: - in: query name: path description: Count redirects with given path. schema: {} required: false - in: query name: target description: Count redirects with given target. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_redirects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/redirects/{redirect_id}.json: get: summary: Shopify Retrieves A Single Redirect description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2020-10 parameters: - in: path name: redirect_id required: true schema: type: string description: redirect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_redirects_param_redirect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/redirects.json: get: summary: Shopify Retrieves A List Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2021-01 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: path description: Show redirects with a given path. schema: {} required: false - in: query name: target description: Show redirects with a given target. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_redirects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/redirects/count.json: get: summary: Shopify Retrieves A Count Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2021-01 parameters: - in: query name: path description: Count redirects with given path. schema: {} required: false - in: query name: target description: Count redirects with given target. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_redirects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/redirects/{redirect_id}.json: get: summary: Shopify Retrieves A Single Redirect description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2021-01 parameters: - in: path name: redirect_id required: true schema: type: string description: redirect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_redirects_param_redirect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/redirects.json: get: summary: Shopify Retrieves A List Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-unstable parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: path description: Show redirects with a given path. schema: {} required: false - in: query name: target description: Show redirects with a given target. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_redirects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/redirects/count.json: get: summary: Shopify Retrieves A Count Of Url Redirects description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-unstable parameters: - in: query name: path description: Count redirects with given path. schema: {} required: false - in: query name: target description: Count redirects with given target. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_redirects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/redirects/{redirect_id}.json: get: summary: Shopify Retrieves A Single Redirect description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-unstable parameters: - in: path name: redirect_id required: true schema: type: string description: redirect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_redirects_param_redirect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/script_tags.json: get: summary: Shopify Retrieves A List Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#index-2020-01 parameters: - in: query name: limit description: "The number of results to return.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: src description: Show script tags with this URL. schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_script_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/script_tags/count.json: get: summary: Shopify Retrieves A Count Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2020-01 parameters: - in: query name: src description: Count only script tags with a given URL. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_script_tags_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/script_tags/{script_tag_id}.json: get: summary: Shopify Retrieves A Single Script Tag description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#show-2020-01 parameters: - in: path name: script_tag_id required: true schema: type: string description: script_tag_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_script_tags_param_script_tag_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/script_tags.json: get: summary: Shopify Retrieves A List Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#index-2020-04 parameters: - in: query name: limit description: "The number of results to return.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: src description: Show script tags with this URL. schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_script_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/script_tags/count.json: get: summary: Shopify Retrieves A Count Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2020-04 parameters: - in: query name: src description: Count only script tags with a given URL. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_script_tags_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/script_tags/{script_tag_id}.json: get: summary: Shopify Retrieves A Single Script Tag description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#show-2020-04 parameters: - in: path name: script_tag_id required: true schema: type: string description: script_tag_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_script_tags_param_script_tag_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/script_tags.json: get: summary: Shopify Retrieves A List Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#index-2020-07 parameters: - in: query name: limit description: "The number of results to return.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: src description: Show script tags with this URL. schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_script_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/script_tags/count.json: get: summary: Shopify Retrieves A Count Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2020-07 parameters: - in: query name: src description: Count only script tags with a given URL. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_script_tags_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/script_tags/{script_tag_id}.json: get: summary: Shopify Retrieves A Single Script Tag description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#show-2020-07 parameters: - in: path name: script_tag_id required: true schema: type: string description: script_tag_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_script_tags_param_script_tag_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/script_tags.json: get: summary: Shopify Retrieves A List Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#index-2020-10 parameters: - in: query name: limit description: "The number of results to return.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: src description: Show script tags with this URL. schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_script_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/script_tags/count.json: get: summary: Shopify Retrieves A Count Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2020-10 parameters: - in: query name: src description: Count only script tags with a given URL. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_script_tags_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/script_tags/{script_tag_id}.json: get: summary: Shopify Retrieves A Single Script Tag description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#show-2020-10 parameters: - in: path name: script_tag_id required: true schema: type: string description: script_tag_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_script_tags_param_script_tag_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/script_tags.json: get: summary: Shopify Retrieves A List Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#index-2021-01 parameters: - in: query name: limit description: "The number of results to return.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: src description: Show script tags with this URL. schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_script_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/script_tags/count.json: get: summary: Shopify Retrieves A Count Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2021-01 parameters: - in: query name: src description: Count only script tags with a given URL. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_script_tags_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/script_tags/{script_tag_id}.json: get: summary: Shopify Retrieves A Single Script Tag description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#show-2021-01 parameters: - in: path name: script_tag_id required: true schema: type: string description: script_tag_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_script_tags_param_script_tag_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/script_tags.json: get: summary: Shopify Retrieves A List Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#index-unstable parameters: - in: query name: limit description: "The number of results to return.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: src description: Show script tags with this URL. schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_script_tags x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/script_tags/count.json: get: summary: Shopify Retrieves A Count Of All Script Tags description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-unstable parameters: - in: query name: src description: Count only script tags with a given URL. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_script_tags_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/script_tags/{script_tag_id}.json: get: summary: Shopify Retrieves A Single Script Tag description: https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#show-unstable parameters: - in: path name: script_tag_id required: true schema: type: string description: script_tag_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_script_tags_param_script_tag_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/themes.json: get: summary: Shopify Retrieves A List Of Themes description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2020-01 parameters: - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_themes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/themes/{theme_id}.json: get: summary: Shopify Retrieves A Single Theme description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#show-2020-01 parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_themes_param_theme_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/themes.json: get: summary: Shopify Retrieves A List Of Themes description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2020-04 parameters: - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_themes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/themes/{theme_id}.json: get: summary: Shopify Retrieves A Single Theme description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#show-2020-04 parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_themes_param_theme_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/themes.json: get: summary: Shopify Retrieves A List Of Themes description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2020-07 parameters: - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_themes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/themes/{theme_id}.json: get: summary: Shopify Retrieves A Single Theme description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#show-2020-07 parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_themes_param_theme_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/themes.json: get: summary: Shopify Retrieves A List Of Themes description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2020-10 parameters: - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_themes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/themes/{theme_id}.json: get: summary: Shopify Retrieves A Single Theme description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#show-2020-10 parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_themes_param_theme_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/themes.json: get: summary: Shopify Retrieves A List Of Themes description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2021-01 parameters: - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_themes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/themes/{theme_id}.json: get: summary: Shopify Retrieves A Single Theme description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#show-2021-01 parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_themes_param_theme_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/themes.json: get: summary: Shopify Retrieves A List Of Themes description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-unstable parameters: - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_themes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/themes/{theme_id}.json: get: summary: Shopify Retrieves A Single Theme description: https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#show-unstable parameters: - in: path name: theme_id required: true schema: type: string description: theme_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_themes_param_theme_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/checkouts/count.json: get: summary: Shopify Retrieves A Count Of Checkouts From The Past 90 Days description: https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2020-01 parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_checkouts_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/checkouts/count.json: get: summary: Shopify Retrieves A Count Of Checkouts From The Past 90 Days description: https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2020-04 parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_checkouts_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/checkouts/count.json: get: summary: Shopify Retrieves A Count Of Checkouts From The Past 90 Days description: https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2020-07 parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_checkouts_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/checkouts/count.json: get: summary: Shopify Retrieves A Count Of Checkouts From The Past 90 Days description: https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2020-10 parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_checkouts_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/checkouts/count.json: get: summary: Shopify Retrieves A Count Of Checkouts From The Past 90 Days description: https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2021-01 parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_checkouts_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/checkouts/count.json: get: summary: Shopify Retrieves A Count Of Checkouts From The Past 90 Days description: https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-unstable parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_checkouts_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders.json: get: summary: Shopify Retrieves A List Of Orders description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#index-2020-01 parameters: - in: query name: ids description: Retrieve only orders specified by a comma-separated list of order IDs. schema: {} required: false - in: query name: limit description: "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Show orders after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show orders created at or after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: processed_at_min description: 'Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: processed_at_max description: 'Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: attribution_app_id 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. schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: financial_status 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." schema: {} required: false - in: query name: fulfillment_status 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." schema: {} required: false - in: query name: fields description: Retrieve only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}.json: get: summary: Shopify Retrieves A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#show-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: fields description: Retrieve only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/count.json: get: summary: Shopify Retrieves An Order Count description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#count-2020-01 parameters: - in: query name: created_at_min description: 'Count orders created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count orders created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count orders last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count orders last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: financial_status 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." schema: {} required: false - in: query name: fulfillment_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders.json: get: summary: Shopify Retrieves A List Of Orders description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#index-2020-04 parameters: - in: query name: ids description: Retrieve only orders specified by a comma-separated list of order IDs. schema: {} required: false - in: query name: limit description: "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Show orders after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show orders created at or after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: processed_at_min description: 'Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: processed_at_max description: 'Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: attribution_app_id 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. schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: financial_status 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." schema: {} required: false - in: query name: fulfillment_status 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." schema: {} required: false - in: query name: fields description: Retrieve only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}.json: get: summary: Shopify Retrieves A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#show-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: fields description: Retrieve only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/count.json: get: summary: Shopify Retrieves An Order Count description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#count-2020-04 parameters: - in: query name: created_at_min description: 'Count orders created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count orders created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count orders last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count orders last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: financial_status 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." schema: {} required: false - in: query name: fulfillment_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders.json: get: summary: Shopify Retrieves A List Of Orders description: https://shopify.dev/docs/admin-api/rest/reference/orders/order#index-2020-07 parameters: - in: query name: ids description: Retrieve only orders specified by a comma-separated list of order IDs. schema: {} required: false - in: query name: limit description: "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Show orders after the specified ID. schema: {} required: false - in: query name: created_at_min description: 'Show orders created at or after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: processed_at_min description: 'Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: processed_at_max description: 'Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: attribution_app_id 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. schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: financial_status 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." schema: {} required: false - in: query name: fulfillment_status 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." schema: {} required: false - in: query name: fields description: Retrieve only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/risks.json: get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/risks.json: get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/risks.json: get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/risks.json: get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Retrieves responses: '200': description: '' operationId: get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Retrieves responses: '200': description: '' operationId: get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/risks.json: get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/risks.json: get: summary: Shopify Retrieves A List Of All Order Risks For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#index-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_risks x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/risks/{risk_id}.json: get: summary: Shopify Retrieves A Single Order Risk By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: risk_id required: true schema: type: string description: risk_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_risks_param_risk_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/refunds/{refund_id}.json: get: summary: Shopify Retrieves A Specific Refund description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#show-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: refund_id required: true schema: type: string description: refund_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_refunds_param_refund_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/refunds/{refund_id}.json: get: summary: Shopify Retrieves A Specific Refund description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#show-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: refund_id required: true schema: type: string description: refund_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_refunds_param_refund_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/refunds/{refund_id}.json: get: summary: Shopify Retrieves A Specific Refund description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#show-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: refund_id required: true schema: type: string description: refund_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_refunds_param_refund_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/refunds/{refund_id}.json: get: summary: Shopify Retrieves A Specific Refund description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#show-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: refund_id required: true schema: type: string description: refund_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_orders_param_order_id_refunds_param_refund_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/refunds/{refund_id}.json: get: summary: Shopify Retrieves A Specific Refund description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#show-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: refund_id required: true schema: type: string description: refund_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_refunds_param_refund_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/refunds.json: get: summary: Shopify Retrieves A List Of Refunds For An Order description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#index-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_refunds x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/refunds/{refund_id}.json: get: summary: Shopify Retrieves A Specific Refund description: https://shopify.dev/docs/admin-api/rest/reference/orders/refund#show-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: refund_id required: true schema: type: string description: refund_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: in_shop_currency description: "Show amounts in the shop currency for the underlying transaction.\n (default: false)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_refunds_param_refund_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/gift_cards.json: get: summary: Shopify Retrieves A List Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-01 parameters: - in: query name: status 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" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_gift_cards x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/gift_cards/{gift_card_id}.json: get: summary: Shopify Retrieves A Single Gift Card By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-01 parameters: - in: path name: gift_card_id required: true schema: type: string description: gift_card_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_gift_cards_param_gift_card_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/gift_cards/count.json: get: summary: Shopify Retrieves A Count Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-01 parameters: - in: query name: status 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" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_gift_cards_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/gift_cards.json: get: summary: Shopify Retrieves A List Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-04 parameters: - in: query name: status 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" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_gift_cards x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/gift_cards/{gift_card_id}.json: get: summary: Shopify Retrieves A Single Gift Card By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-04 parameters: - in: path name: gift_card_id required: true schema: type: string description: gift_card_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_gift_cards_param_gift_card_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/gift_cards/count.json: get: summary: Shopify Retrieves A Count Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-04 parameters: - in: query name: status 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" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_gift_cards_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/gift_cards.json: get: summary: Shopify Retrieves A List Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-07 parameters: - in: query name: status 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" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_gift_cards x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/gift_cards/{gift_card_id}.json: get: summary: Shopify Retrieves A Single Gift Card By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-07 parameters: - in: path name: gift_card_id required: true schema: type: string description: gift_card_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_gift_cards_param_gift_card_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/gift_cards/count.json: get: summary: Shopify Retrieves A Count Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-07 parameters: - in: query name: status 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" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_gift_cards_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/gift_cards.json: get: summary: Shopify Retrieves A List Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2020-10 parameters: - in: query name: status 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" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_gift_cards x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/gift_cards/{gift_card_id}.json: get: summary: Shopify Retrieves A Single Gift Card By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-10 parameters: - in: path name: gift_card_id required: true schema: type: string description: gift_card_id tags: - Retrieves responses: '200': description: '' operationId: get_gift_cards_param_gift_card_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/gift_cards/count.json: get: summary: Shopify Retrieves A Count Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-10 parameters: - in: query name: status 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" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_gift_cards_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/gift_cards.json: get: summary: Shopify Retrieves A List Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-2021-01 parameters: - in: query name: status 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" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_gift_cards x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/gift_cards/{gift_card_id}.json: get: summary: Shopify Retrieves A Single Gift Card By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2021-01 parameters: - in: path name: gift_card_id required: true schema: type: string description: gift_card_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_gift_cards_param_gift_card_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/gift_cards/count.json: get: summary: Shopify Retrieves A Count Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2021-01 parameters: - in: query name: status 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" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_gift_cards_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/gift_cards.json: get: summary: Shopify Retrieves A List Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#index-unstable parameters: - in: query name: status 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" schema: {} required: false - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_gift_cards x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/gift_cards/{gift_card_id}.json: get: summary: Shopify Retrieves A Single Gift Card By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-unstable parameters: - in: path name: gift_card_id required: true schema: type: string description: gift_card_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_gift_cards_param_gift_card_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/gift_cards/count.json: get: summary: Shopify Retrieves A Count Of Gift Cards description: https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-unstable parameters: - in: query name: status 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" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_gift_cards_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/users.json: get: summary: Shopify Retrieves A List Of All Users description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-01 parameters: - in: query name: limit description: "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: page_info description: A unique ID used to access a certain page of results. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_users x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/users/{user_id}.json: get: summary: Shopify Retrieves A Single User description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-01 parameters: - in: path name: user_id required: true schema: type: string description: user_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_users_param_user_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/users/current.json: get: summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_users_current x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/users.json: get: summary: Shopify Retrieves A List Of All Users description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-04 parameters: - in: query name: limit description: "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: page_info description: A unique ID used to access a certain page of results. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_users x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/users/{user_id}.json: get: summary: Shopify Retrieves A Single User description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-04 parameters: - in: path name: user_id required: true schema: type: string description: user_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_users_param_user_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/users/current.json: get: summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_users_current x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/users.json: get: summary: Shopify Retrieves A List Of All Users description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-07 parameters: - in: query name: limit description: "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: page_info description: A unique ID used to access a certain page of results. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_users x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/users/{user_id}.json: get: summary: Shopify Retrieves A Single User description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-07 parameters: - in: path name: user_id required: true schema: type: string description: user_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_users_param_user_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/users/current.json: get: summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_users_current x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/users.json: get: summary: Shopify Retrieves A List Of All Users description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-10 parameters: - in: query name: limit description: "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: page_info description: A unique ID used to access a certain page of results. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_users x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/users/{user_id}.json: get: summary: Shopify Retrieves A Single User description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-10 parameters: - in: path name: user_id required: true schema: type: string description: user_id tags: - Retrieves responses: '200': description: '' operationId: get_users_param_user_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/users/current.json: get: summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-10 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: get_users_current x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/users.json: get: summary: Shopify Retrieves A List Of All Users description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2021-01 parameters: - in: query name: limit description: "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: page_info description: A unique ID used to access a certain page of results. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_users x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/users/{user_id}.json: get: summary: Shopify Retrieves A Single User description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2021-01 parameters: - in: path name: user_id required: true schema: type: string description: user_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_users_param_user_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/users/current.json: get: summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_users_current x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/users.json: get: summary: Shopify Retrieves A List Of All Users description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-unstable parameters: - in: query name: limit description: "The maximum number of results to show on a page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: page_info description: A unique ID used to access a certain page of results. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_users x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/users/{user_id}.json: get: summary: Shopify Retrieves A Single User description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-unstable parameters: - in: path name: user_id required: true schema: type: string description: user_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_users_param_user_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/users/current.json: get: summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_users_current x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/collects.json: get: summary: Shopify Retrieves A List Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-2020-01 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_collects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/collects/{collect_id}.json: get: summary: Shopify Retrieves A Specific Collect By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2020-01 parameters: - in: path name: collect_id required: true schema: type: string description: collect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_collects_param_collect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/collects/count.json: get: summary: Shopify Retrieves A Count Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2020-01 parameters: - in: query name: collection_id schema: type: integer description: collection_id required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_collects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/collects.json: get: summary: Shopify Retrieves A List Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-2020-04 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_collects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/collects/{collect_id}.json: get: summary: Shopify Retrieves A Specific Collect By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2020-04 parameters: - in: path name: collect_id required: true schema: type: string description: collect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_collects_param_collect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/collects/count.json: get: summary: Shopify Retrieves A Count Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2020-04 parameters: - in: query name: collection_id schema: type: integer description: collection_id required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_collects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/collects.json: get: summary: Shopify Retrieves A List Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-2020-07 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_collects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/collects/{collect_id}.json: get: summary: Shopify Retrieves A Specific Collect By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2020-07 parameters: - in: path name: collect_id required: true schema: type: string description: collect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_collects_param_collect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/collects/count.json: get: summary: Shopify Retrieves A Count Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2020-07 parameters: - in: query name: collection_id schema: type: integer description: collection_id required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_collects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/collects.json: get: summary: Shopify Retrieves A List Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-2020-10 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_collects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/collects/{collect_id}.json: get: summary: Shopify Retrieves A Specific Collect By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2020-10 parameters: - in: path name: collect_id required: true schema: type: string description: collect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_collects_param_collect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/collects/count.json: get: summary: Shopify Retrieves A Count Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2020-10 parameters: - in: query name: collection_id schema: type: integer description: collection_id required: false tags: - Retrieves responses: '200': description: '' operationId: get_collects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/collects.json: get: summary: Shopify Retrieves A List Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-2021-01 parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_collects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/collects/{collect_id}.json: get: summary: Shopify Retrieves A Specific Collect By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2021-01 parameters: - in: path name: collect_id required: true schema: type: string description: collect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_collects_param_collect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/collects/count.json: get: summary: Shopify Retrieves A Count Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2021-01 parameters: - in: query name: collection_id schema: type: integer description: collection_id required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_collects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/collects.json: get: summary: Shopify Retrieves A List Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#index-unstable parameters: - in: query name: limit description: "The maximum number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_collects x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/collects/{collect_id}.json: get: summary: Shopify Retrieves A Specific Collect By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-unstable parameters: - in: path name: collect_id required: true schema: type: string description: collect_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_collects_param_collect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/collects/count.json: get: summary: Shopify Retrieves A Count Of Collects description: https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-unstable parameters: - in: query name: collection_id schema: type: integer description: collection_id required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_collects_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/collections/{collection_id}.json: get: summary: Shopify Retrieves A Single Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#show-2020-01 parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_collections_param_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/collections/{collection_id}/products.json: get: summary: Shopify Retrieve A List Of Products Belonging To A Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2020-01 parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: limit description: "The number of products to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_collections_param_collection_id_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/collections/{collection_id}.json: get: summary: Shopify Retrieves A Single Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#show-2020-04 parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_collections_param_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/collections/{collection_id}/products.json: get: summary: Shopify Retrieve A List Of Products Belonging To A Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2020-04 parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: limit description: "The number of products to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_collections_param_collection_id_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/collections/{collection_id}.json: get: summary: Shopify Retrieves A Single Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#show-2020-07 parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_collections_param_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/collections/{collection_id}/products.json: get: summary: Shopify Retrieve A List Of Products Belonging To A Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2020-07 parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: limit description: "The number of products to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_collections_param_collection_id_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/collections/{collection_id}.json: get: summary: Shopify Retrieves A Single Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#show-2020-10 parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_collections_param_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/collections/{collection_id}/products.json: get: summary: Shopify Retrieve A List Of Products Belonging To A Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2020-10 parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: limit description: "The number of products to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_collections_param_collection_id_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/collections/{collection_id}.json: get: summary: Shopify Retrieves A Single Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#show-2021-01 parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_collections_param_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/collections/{collection_id}/products.json: get: summary: Shopify Retrieve A List Of Products Belonging To A Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2021-01 parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: limit description: "The number of products to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_collections_param_collection_id_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/collections/{collection_id}.json: get: summary: Shopify Retrieves A Single Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#show-unstable parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_collections_param_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/collections/{collection_id}/products.json: get: summary: Shopify Retrieve A List Of Products Belonging To A Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-unstable parameters: - in: path name: collection_id required: true schema: type: string description: collection_id - in: query name: limit description: "The number of products to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_collections_param_collection_id_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-01 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-01 parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/custom_collections/{custom_collection_id}.json: get: summary: Shopify Retrieves A Single Custom Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2020-01 parameters: - in: path name: custom_collection_id required: true schema: type: string description: custom_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_custom_collections_param_custom_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-04 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-04 parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/custom_collections/{custom_collection_id}.json: get: summary: Shopify Retrieves A Single Custom Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2020-04 parameters: - in: path name: custom_collection_id required: true schema: type: string description: custom_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_custom_collections_param_custom_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-07 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-07 parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/custom_collections/{custom_collection_id}.json: get: summary: Shopify Retrieves A Single Custom Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2020-07 parameters: - in: path name: custom_collection_id required: true schema: type: string description: custom_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_custom_collections_param_custom_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-10 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-10 parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/custom_collections/{custom_collection_id}.json: get: summary: Shopify Retrieves A Single Custom Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2020-10 parameters: - in: path name: custom_collection_id required: true schema: type: string description: custom_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_custom_collections_param_custom_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2021-01 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2021-01 parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/custom_collections/{custom_collection_id}.json: get: summary: Shopify Retrieves A Single Custom Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2021-01 parameters: - in: path name: custom_collection_id required: true schema: type: string description: custom_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_custom_collections_param_custom_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-unstable parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-unstable parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/custom_collections/{custom_collection_id}.json: get: summary: Shopify Retrieves A Single Custom Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-unstable parameters: - in: path name: custom_collection_id required: true schema: type: string description: custom_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_custom_collections_param_custom_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/products.json: get: summary: Shopify Retrieves A List Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2020-01 parameters: - in: query name: ids description: Return only products specified by a comma-separated list of product IDs. schema: {} required: false - in: query name: limit description: "Return up to this many results per page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Filter results by product title. schema: {} required: false - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: handle description: Filter results by product handle. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: collection_id description: Filter results by product collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: presentment_currencies description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/products/count.json: get: summary: Shopify Retrieves A Count Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2020-01 parameters: - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: collection_id description: Filter results by collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_products_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/products/{product_id}.json: get: summary: Shopify Retrieves A Single Product description: https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2020-01 parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_products_param_product_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/products.json: get: summary: Shopify Retrieves A List Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2020-04 parameters: - in: query name: ids description: Return only products specified by a comma-separated list of product IDs. schema: {} required: false - in: query name: limit description: "Return up to this many results per page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Filter results by product title. schema: {} required: false - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: handle description: Filter results by product handle. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: collection_id description: Filter results by product collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: presentment_currencies description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/products/count.json: get: summary: Shopify Retrieves A Count Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2020-04 parameters: - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: collection_id description: Filter results by collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_products_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/products/{product_id}.json: get: summary: Shopify Retrieves A Single Product description: https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2020-04 parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_products_param_product_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/products.json: get: summary: Shopify Retrieves A List Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2020-07 parameters: - in: query name: ids description: Return only products specified by a comma-separated list of product IDs. schema: {} required: false - in: query name: limit description: "Return up to this many results per page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Filter results by product title. schema: {} required: false - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: handle description: Filter results by product handle. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: collection_id description: Filter results by product collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: presentment_currencies description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/products/count.json: get: summary: Shopify Retrieves A Count Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2020-07 parameters: - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: collection_id description: Filter results by collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_products_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/products/{product_id}.json: get: summary: Shopify Retrieves A Single Product description: https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2020-07 parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_products_param_product_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/products.json: get: summary: Shopify Retrieves A List Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2020-10 parameters: - in: query name: ids description: Return only products specified by a comma-separated list of product IDs. schema: {} required: false - in: query name: limit description: "Return up to this many results per page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Filter results by product title. schema: {} required: false - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: handle description: Filter results by product handle. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: collection_id description: Filter results by product collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: presentment_currencies description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/products/count.json: get: summary: Shopify Retrieves A Count Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2020-10 parameters: - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: collection_id description: Filter results by collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_products_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/products/{product_id}.json: get: summary: Shopify Retrieves A Single Product description: https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2020-10 parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_products_param_product_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/products.json: get: summary: Shopify Retrieves A List Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2021-01 parameters: - in: query name: ids description: Return only products specified by a comma-separated list of product IDs. schema: {} required: false - in: query name: limit description: "Return up to this many results per page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Filter results by product title. schema: {} required: false - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: handle description: Filter results by product handle. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: collection_id description: Filter results by product collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: presentment_currencies description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/products/count.json: get: summary: Shopify Retrieves A Count Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2021-01 parameters: - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: collection_id description: Filter results by collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_products_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/products/{product_id}.json: get: summary: Shopify Retrieves A Single Product description: https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2021-01 parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_products_param_product_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/products.json: get: summary: Shopify Retrieves A List Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#index-unstable parameters: - in: query name: ids description: Return only products specified by a comma-separated list of product IDs. schema: {} required: false - in: query name: limit description: "Return up to this many results per page.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Filter results by product title. schema: {} required: false - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: handle description: Filter results by product handle. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: status 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." schema: {} required: false - in: query name: collection_id description: Filter results by product collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false - in: query name: presentment_currencies description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_products x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/products/count.json: get: summary: Shopify Retrieves A Count Of Products description: https://shopify.dev/docs/admin-api/rest/reference/products/product#count-unstable parameters: - in: query name: vendor description: Filter results by product vendor. schema: {} required: false - in: query name: product_type description: Filter results by product type. schema: {} required: false - in: query name: collection_id description: Filter results by collection ID. schema: {} required: false - in: query name: created_at_min description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: created_at_max description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_min description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_products_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/products/{product_id}.json: get: summary: Shopify Retrieves A Single Product description: https://shopify.dev/docs/admin-api/rest/reference/products/product#show-unstable parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_products_param_product_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-01 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-01 parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/smart_collections/{smart_collection_id}.json: get: summary: Shopify Retrieves A Single Smart Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#show-2020-01 parameters: - in: path name: smart_collection_id required: true schema: type: string description: smart_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_smart_collections_param_smart_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-04 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-04 parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/smart_collections/{smart_collection_id}.json: get: summary: Shopify Retrieves A Single Smart Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#show-2020-04 parameters: - in: path name: smart_collection_id required: true schema: type: string description: smart_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_smart_collections_param_smart_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-07 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-07 parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/smart_collections/{smart_collection_id}.json: get: summary: Shopify Retrieves A Single Smart Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#show-2020-07 parameters: - in: path name: smart_collection_id required: true schema: type: string description: smart_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_smart_collections_param_smart_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-10 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-10 parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/smart_collections/{smart_collection_id}.json: get: summary: Shopify Retrieves A Single Smart Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#show-2020-10 parameters: - in: path name: smart_collection_id required: true schema: type: string description: smart_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_smart_collections_param_smart_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2021-01 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2021-01 parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/smart_collections/{smart_collection_id}.json: get: summary: Shopify Retrieves A Single Smart Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#show-2021-01 parameters: - in: path name: smart_collection_id required: true schema: type: string description: smart_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_smart_collections_param_smart_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-unstable parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-unstable parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/smart_collections/{smart_collection_id}.json: get: summary: Shopify Retrieves A Single Smart Collection description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#show-unstable parameters: - in: path name: smart_collection_id required: true schema: type: string description: smart_collection_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_smart_collections_param_smart_collection_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/checkouts/{token}.json: get: summary: Shopify Retrieves A Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-01 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_checkouts_param_token x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/checkouts/{token}/shipping_rates.json: get: summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-01 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_checkouts_param_token_shipping_rates x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/checkouts/{token}.json: get: summary: Shopify Retrieves A Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-04 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_checkouts_param_token x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/checkouts/{token}/shipping_rates.json: get: summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-04 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_checkouts_param_token_shipping_rates x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/checkouts/{token}.json: get: summary: Shopify Retrieves A Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-07 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_checkouts_param_token x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/checkouts/{token}/shipping_rates.json: get: summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-07 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_checkouts_param_token_shipping_rates x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/checkouts/{token}.json: get: summary: Shopify Retrieves A Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-10 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: get_checkouts_param_token x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/checkouts/{token}/shipping_rates.json: get: summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-10 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: get_checkouts_param_token_shipping_rates x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/checkouts/{token}.json: get: summary: Shopify Retrieves A Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2021-01 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_checkouts_param_token x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/checkouts/{token}/shipping_rates.json: get: summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2021-01 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_checkouts_param_token_shipping_rates x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/checkouts/{token}.json: get: summary: Shopify Retrieves A Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-unstable parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_checkouts_param_token x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/checkouts/{token}/shipping_rates.json: get: summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-unstable parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_checkouts_param_token_shipping_rates x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/collection_listings.json: get: summary: Shopify Retrieve Collection Listings That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-01 parameters: - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_collection_listings x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/collection_listings/{collection_listing_id}/product_ids.json: get: summary: Shopify Retrieve Product_ids That Are Published To A Collection_id description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-2020-01 parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_collection_listings_param_collection_listing_id_product_ids x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/collection_listings/{collection_listing_id}.json: get: summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-01 parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_collection_listings_param_collection_listing_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/collection_listings.json: get: summary: Shopify Retrieve Collection Listings That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-04 parameters: - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_collection_listings x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/collection_listings/{collection_listing_id}/product_ids.json: get: summary: Shopify Retrieve Product_ids That Are Published To A Collection_id description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-2020-04 parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_collection_listings_param_collection_listing_id_product_ids x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/collection_listings/{collection_listing_id}.json: get: summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-04 parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_collection_listings_param_collection_listing_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/collection_listings.json: get: summary: Shopify Retrieve Collection Listings That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-07 parameters: - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_collection_listings x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/collection_listings/{collection_listing_id}/product_ids.json: get: summary: Shopify Retrieve Product_ids That Are Published To A Collection_id description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-2020-07 parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_collection_listings_param_collection_listing_id_product_ids x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/collection_listings/{collection_listing_id}.json: get: summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-07 parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_collection_listings_param_collection_listing_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/collection_listings.json: get: summary: Shopify Retrieve Collection Listings That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2020-10 parameters: - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_collection_listings x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/collection_listings/{collection_listing_id}/product_ids.json: get: summary: Shopify Retrieve Product_ids That Are Published To A Collection_id description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-2020-10 parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_collection_listings_param_collection_listing_id_product_ids x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/collection_listings/{collection_listing_id}.json: get: summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-10 parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id tags: - Retrieves responses: '200': description: '' operationId: get_collection_listings_param_collection_listing_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/collection_listings.json: get: summary: Shopify Retrieve Collection Listings That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-2021-01 parameters: - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_collection_listings x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/collection_listings/{collection_listing_id}/product_ids.json: get: summary: Shopify Retrieve Product_ids That Are Published To A Collection_id description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-2021-01 parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_collection_listings_param_collection_listing_id_product_ids x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/collection_listings/{collection_listing_id}.json: get: summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2021-01 parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_collection_listings_param_collection_listing_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/collection_listings.json: get: summary: Shopify Retrieve Collection Listings That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#index-unstable parameters: - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_collection_listings x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/collection_listings/{collection_listing_id}/product_ids.json: get: summary: Shopify Retrieve Product_ids That Are Published To A Collection_id description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#product_ids-unstable parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_collection_listings_param_collection_listing_id_product_ids x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/collection_listings/{collection_listing_id}.json: get: summary: Shopify Retrieve A Specific Collection Listing That Is Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-unstable parameters: - in: path name: collection_listing_id required: true schema: type: string description: collection_listing_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_collection_listings_param_collection_listing_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/checkouts/{token}/payments.json: get: summary: Shopify Retrieves A List Of Payments On A Particular Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-01 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/checkouts/{token}/payments/{payment_id}.json: get: summary: Shopify Retrieves The Payment Information For An Existing Payment description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-01 parameters: - in: path name: token required: true schema: type: string description: token - in: path name: payment_id required: true schema: type: string description: payment_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_checkouts_param_token_payments_param_payment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/checkouts/{token}/payments.json: get: summary: Shopify Retrieves A List Of Payments On A Particular Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-04 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/checkouts/{token}/payments/{payment_id}.json: get: summary: Shopify Retrieves The Payment Information For An Existing Payment description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-04 parameters: - in: path name: token required: true schema: type: string description: token - in: path name: payment_id required: true schema: type: string description: payment_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_checkouts_param_token_payments_param_payment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/checkouts/{token}/payments.json: get: summary: Shopify Retrieves A List Of Payments On A Particular Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-07 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/checkouts/{token}/payments/{payment_id}.json: get: summary: Shopify Retrieves The Payment Information For An Existing Payment description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-07 parameters: - in: path name: token required: true schema: type: string description: token - in: path name: payment_id required: true schema: type: string description: payment_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_checkouts_param_token_payments_param_payment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/checkouts/{token}/payments.json: get: summary: Shopify Retrieves A List Of Payments On A Particular Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-10 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: get_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/checkouts/{token}/payments/{payment_id}.json: get: summary: Shopify Retrieves The Payment Information For An Existing Payment description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-10 parameters: - in: path name: token required: true schema: type: string description: token - in: path name: payment_id required: true schema: type: string description: payment_id tags: - Retrieves responses: '200': description: '' operationId: get_checkouts_param_token_payments_param_payment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/checkouts/{token}/payments.json: get: summary: Shopify Retrieves A List Of Payments On A Particular Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2021-01 parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/checkouts/{token}/payments/{payment_id}.json: get: summary: Shopify Retrieves The Payment Information For An Existing Payment description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2021-01 parameters: - in: path name: token required: true schema: type: string description: token - in: path name: payment_id required: true schema: type: string description: payment_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_checkouts_param_token_payments_param_payment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/checkouts/{token}/payments.json: get: summary: Shopify Retrieves A List Of Payments On A Particular Checkout description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-unstable parameters: - in: path name: token required: true schema: type: string description: token tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/checkouts/{token}/payments/{payment_id}.json: get: summary: Shopify Retrieves The Payment Information For An Existing Payment description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-unstable parameters: - in: path name: token required: true schema: type: string description: token - in: path name: payment_id required: true schema: type: string description: payment_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_checkouts_param_token_payments_param_payment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/product_listings.json: get: summary: Shopify Retrieve Product Listings That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-01 parameters: - in: query name: product_ids description: A comma-separated list of product ids schema: {} required: false - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false - in: query name: collection_id description: Filter by products belonging to a particular collection schema: {} required: false - in: query name: updated_at_min description: Filter by products last updated after a certain date and time (formatted in ISO 8601) schema: {} required: false - in: query name: handle description: Filter by product handle schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_product_listings x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/product_listings/product_ids.json: get: summary: Shopify Retrieve Product_ids That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#product_ids-2020-01 parameters: - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_product_listings_product_ids x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/product_listings/count.json: get: summary: Shopify Retrieve A Count Of Products That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#count-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_product_listings_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/product_listings/{product_listing_id}.json: get: summary: Shopify Retrieve A Specific Product Listing That Is Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-01 parameters: - in: path name: product_listing_id required: true schema: type: string description: product_listing_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_product_listings_param_product_listing_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/product_listings.json: get: summary: Shopify Retrieve Product Listings That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-04 parameters: - in: query name: product_ids description: A comma-separated list of product ids schema: {} required: false - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false - in: query name: collection_id description: Filter by products belonging to a particular collection schema: {} required: false - in: query name: updated_at_min description: Filter by products last updated after a certain date and time (formatted in ISO 8601) schema: {} required: false - in: query name: handle description: Filter by product handle schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_product_listings x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/product_listings/product_ids.json: get: summary: Shopify Retrieve Product_ids That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#product_ids-2020-04 parameters: - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_product_listings_product_ids x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/product_listings/count.json: get: summary: Shopify Retrieve A Count Of Products That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#count-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_product_listings_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/product_listings/{product_listing_id}.json: get: summary: Shopify Retrieve A Specific Product Listing That Is Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-04 parameters: - in: path name: product_listing_id required: true schema: type: string description: product_listing_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_product_listings_param_product_listing_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/product_listings.json: get: summary: Shopify Retrieve Product Listings That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-07 parameters: - in: query name: product_ids description: A comma-separated list of product ids schema: {} required: false - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false - in: query name: collection_id description: Filter by products belonging to a particular collection schema: {} required: false - in: query name: updated_at_min description: Filter by products last updated after a certain date and time (formatted in ISO 8601) schema: {} required: false - in: query name: handle description: Filter by product handle schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_product_listings x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/product_listings/product_ids.json: get: summary: Shopify Retrieve Product_ids That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#product_ids-2020-07 parameters: - in: query name: limit description: "Amount of results\n (default: 50, maximum: 1000)" schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_product_listings_product_ids x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/product_listings/count.json: get: summary: Shopify Retrieve A Count Of Products That Are Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#count-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_product_listings_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/product_listings/{product_listing_id}.json: get: summary: Shopify Retrieve A Specific Product Listing That Is Published To Your App description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-07 parameters: - in: path name: product_listing_id required: true schema: type: string description: product_listing_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_product_listings_param_product_listing_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/assigned_fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2020-01 parameters: - in: query name: assignment_status 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." schema: {} required: false - in: query name: location_ids description: The IDs of the assigned locations of the fulfillment orders that should be returned. schema: {} required: false - in: query name: location_ids[] schema: type: integer description: location_ids[] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_assigned_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/assigned_fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2020-04 parameters: - in: query name: assignment_status 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." schema: {} required: false - in: query name: location_ids description: The IDs of the assigned locations of the fulfillment orders that should be returned. schema: {} required: false - in: query name: location_ids[] schema: type: integer description: location_ids[] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_assigned_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/assigned_fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2020-07 parameters: - in: query name: assignment_status 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." schema: {} required: false - in: query name: location_ids description: The IDs of the assigned locations of the fulfillment orders that should be returned. schema: {} required: false - in: query name: location_ids[] schema: type: integer description: location_ids[] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_assigned_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/assigned_fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2020-10 parameters: - in: query name: assignment_status 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." schema: {} required: false - in: query name: location_ids description: The IDs of the assigned locations of the fulfillment orders that should be returned. schema: {} required: false - in: query name: location_ids[] schema: type: integer description: location_ids[] required: false tags: - Retrieves responses: '200': description: '' operationId: get_assigned_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/assigned_fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2021-01 parameters: - in: query name: assignment_status 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." schema: {} required: false - in: query name: location_ids description: The IDs of the assigned locations of the fulfillment orders that should be returned. schema: {} required: false - in: query name: location_ids[] schema: type: integer description: location_ids[] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_assigned_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/assigned_fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-unstable parameters: - in: query name: assignment_status 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." schema: {} required: false - in: query name: location_ids description: The IDs of the assigned locations of the fulfillment orders that should be returned. schema: {} required: false - in: query name: location_ids[] schema: type: integer description: location_ids[] required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_assigned_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/carrier_services.json: get: summary: Shopify Retrieves A List Of Carrier Services description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_carrier_services x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/carrier_services/{carrier_service_id}.json: get: summary: Shopify Retrieves A Single Carrier Service By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-01 parameters: - in: path name: carrier_service_id required: true schema: type: string description: carrier_service_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_carrier_services_param_carrier_service_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/carrier_services.json: get: summary: Shopify Retrieves A List Of Carrier Services description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_carrier_services x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/carrier_services/{carrier_service_id}.json: get: summary: Shopify Retrieves A Single Carrier Service By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-04 parameters: - in: path name: carrier_service_id required: true schema: type: string description: carrier_service_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_carrier_services_param_carrier_service_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/carrier_services.json: get: summary: Shopify Retrieves A List Of Carrier Services description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_carrier_services x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/carrier_services/{carrier_service_id}.json: get: summary: Shopify Retrieves A Single Carrier Service By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-07 parameters: - in: path name: carrier_service_id required: true schema: type: string description: carrier_service_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_carrier_services_param_carrier_service_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/carrier_services.json: get: summary: Shopify Retrieves A List Of Carrier Services description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2020-10 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: get_carrier_services x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/carrier_services/{carrier_service_id}.json: get: summary: Shopify Retrieves A Single Carrier Service By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-10 parameters: - in: path name: carrier_service_id required: true schema: type: string description: carrier_service_id tags: - Retrieves responses: '200': description: '' operationId: get_carrier_services_param_carrier_service_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/carrier_services.json: get: summary: Shopify Retrieves A List Of Carrier Services description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_carrier_services x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/carrier_services/{carrier_service_id}.json: get: summary: Shopify Retrieves A Single Carrier Service By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2021-01 parameters: - in: path name: carrier_service_id required: true schema: type: string description: carrier_service_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_carrier_services_param_carrier_service_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/carrier_services.json: get: summary: Shopify Retrieves A List Of Carrier Services description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_carrier_services x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/carrier_services/{carrier_service_id}.json: get: summary: Shopify Retrieves A Single Carrier Service By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-unstable parameters: - in: path name: carrier_service_id required: true schema: type: string description: carrier_service_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_carrier_services_param_carrier_service_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.json: get: summary: Shopify Retrieve A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#show-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fields description: Comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_fulfillments_param_fulfillment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}.json: get: summary: Shopify Retrieve A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#show-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fields description: Comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_fulfillments_param_fulfillment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.json: get: summary: Shopify Retrieve A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#show-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fields description: Comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_fulfillments_param_fulfillment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}.json: get: summary: Shopify Retrieve A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#show-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fields description: Comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_orders_param_order_id_fulfillments_param_fulfillment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}.json: get: summary: Shopify Retrieve A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#show-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fields description: Comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_fulfillments_param_fulfillment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With An Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#index-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_max description: 'Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_min description: 'Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false - in: query name: limit description: "Limit the amount of results.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: updated_at_max description: 'Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillments.json: get: summary: Shopify Retrieves Fulfillments Associated With A Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order that is associated with the fulfillments. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_fulfillment_orders_param_fulfillment_order_id_fulfillments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillments/count.json: get: summary: Shopify Retrieves A Count Of Fulfillments Associated With A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: created_at_min description: 'Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: created_at_max description: 'Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_min description: 'Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_fulfillments_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}.json: get: summary: Shopify Retrieve A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#show-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fields description: Comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_fulfillments_param_fulfillment_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json: get: summary: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fulfillment_id description: The ID of the fulfillment that's associated with the fulfillment event. schema: {} required: false - in: query name: order_id description: The ID of the order that's associated with the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_fulfillments_param_fulfillment_id_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Event description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: path name: event_id required: true schema: type: string description: event_id - in: query name: event_id description: The ID of the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_fulfillments_param_fulfillment_id_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.json: get: summary: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fulfillment_id description: The ID of the fulfillment that's associated with the fulfillment event. schema: {} required: false - in: query name: order_id description: The ID of the order that's associated with the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_fulfillments_param_fulfillment_id_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Event description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: path name: event_id required: true schema: type: string description: event_id - in: query name: event_id description: The ID of the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_fulfillments_param_fulfillment_id_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events.json: get: summary: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fulfillment_id description: The ID of the fulfillment that's associated with the fulfillment event. schema: {} required: false - in: query name: order_id description: The ID of the order that's associated with the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_fulfillments_param_fulfillment_id_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Event description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: path name: event_id required: true schema: type: string description: event_id - in: query name: event_id description: The ID of the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_fulfillments_param_fulfillment_id_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events.json: get: summary: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fulfillment_id description: The ID of the fulfillment that's associated with the fulfillment event. schema: {} required: false - in: query name: order_id description: The ID of the order that's associated with the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_orders_param_order_id_fulfillments_param_fulfillment_id_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Event description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: path name: event_id required: true schema: type: string description: event_id - in: query name: event_id description: The ID of the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_orders_param_order_id_fulfillments_param_fulfillment_id_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json: get: summary: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fulfillment_id description: The ID of the fulfillment that's associated with the fulfillment event. schema: {} required: false - in: query name: order_id description: The ID of the order that's associated with the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_fulfillments_param_fulfillment_id_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Event description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: path name: event_id required: true schema: type: string description: event_id - in: query name: event_id description: The ID of the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_fulfillments_param_fulfillment_id_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events.json: get: summary: Shopify Retrieves A List Of Fulfillment Events For A Specific Fulfillment description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: query name: fulfillment_id description: The ID of the fulfillment that's associated with the fulfillment event. schema: {} required: false - in: query name: order_id description: The ID of the order that's associated with the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_fulfillments_param_fulfillment_id_events x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Event description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: path name: fulfillment_id required: true schema: type: string description: fulfillment_id - in: path name: event_id required: true schema: type: string description: event_id - in: query name: event_id description: The ID of the fulfillment event. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_fulfillments_param_fulfillment_id_events_param_event_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-04 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-07 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-10 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Retrieves responses: '200': description: '' operationId: get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2021-01 parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillment_orders.json: get: summary: Shopify Retrieves A List Of Fulfillment Orders For A Specific Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-unstable parameters: - in: path name: order_id required: true schema: type: string description: order_id - in: query name: order_id description: The ID of the order that is associated with the fulfillment orders. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_orders_param_order_id_fulfillment_orders x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}.json: get: summary: Shopify Retrieves A Specific Fulfillment Order description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_fulfillment_orders_param_fulfillment_order_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-04 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-07 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-10 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2021-01 parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/locations_for_move.json: get: summary: Shopify Retrieves A List Of Locations That A Fulfillment Order Can Potentially Move To description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-unstable parameters: - in: path name: fulfillment_order_id required: true schema: type: string description: fulfillment_order_id - in: query name: fulfillment_order_id description: The ID of the fulfillment order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_fulfillment_orders_param_fulfillment_order_id_locations_for_move x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/shopify_payments/balance.json: get: summary: Shopify Retrieves The Account's Current Balance description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_shopify_payments_balance x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/shopify_payments/balance.json: get: summary: Shopify Retrieves The Account's Current Balance description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_shopify_payments_balance x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/shopify_payments/balance.json: get: summary: Shopify Retrieves The Account's Current Balance description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_shopify_payments_balance x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/shopify_payments/balance.json: get: summary: Shopify Retrieves The Account's Current Balance description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2020-10 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: get_shopify_payments_balance x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/shopify_payments/balance.json: get: summary: Shopify Retrieves The Account's Current Balance description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_shopify_payments_balance x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/shopify_payments/balance.json: get: summary: Shopify Retrieves The Account's Current Balance description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_shopify_payments_balance x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/shopify_payments/disputes.json: get: summary: Shopify Retrieve All Disputes Ordered By Initiated_at Date And Time (iso 8601 Format) description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/dispute#index-2020-01 parameters: - in: query name: since_id description: Return only disputes after the specified ID. schema: {} required: false - in: query name: last_id description: Return only disputes before the specified ID. schema: {} required: false - in: query name: status description: Return only disputes with the specified status. schema: {} required: false - in: query name: initiated_at description: Return only disputes with the specified initiated_at date (ISO 8601 format). schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_shopify_payments_disputes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/shopify_payments/disputes/{dispute_id}.json: get: summary: Shopify Retrieves A Single Dispute By Id description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/dispute#show-2020-01 parameters: - in: path name: dispute_id required: true schema: type: string description: dispute_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_shopify_payments_disputes_param_dispute_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/shopify_payments/disputes.json: get: summary: Shopify Retrieve All Disputes Ordered By Initiated_at Date And Time (iso 8601 Format) description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/dispute#index-2020-04 parameters: - in: query name: since_id description: Return only disputes after the specified ID. schema: {} required: false - in: query name: last_id description: Return only disputes before the specified ID. schema: {} required: false - in: query name: status description: Return only disputes with the specified status. schema: {} required: false - in: query name: initiated_at description: Return only disputes with the specified initiated_at date (ISO 8601 format). schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_shopify_payments_disputes x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/shopify_payments/payouts.json: get: summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-01 parameters: - in: query name: since_id description: Filter the response to payouts made after the specified ID. schema: {} required: false - in: query name: last_id description: Filter the response to payouts made before the specified ID. schema: {} required: false - in: query name: date_min description: Filter the response to payouts made inclusively after the specified date. schema: {} required: false - in: query name: date_max description: Filter the response to payouts made inclusively before the specified date. schema: {} required: false - in: query name: date description: Filter the response to payouts made on the specified date. schema: {} required: false - in: query name: status description: Filter the response to payouts made with the specified status. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_shopify_payments_payouts x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/shopify_payments/payouts/{payout_id}.json: get: summary: Shopify Retrieves A Single Payout By Id description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-01 parameters: - in: path name: payout_id required: true schema: type: string description: payout_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_shopify_payments_payouts_param_payout_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/shopify_payments/payouts.json: get: summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-04 parameters: - in: query name: since_id description: Filter the response to payouts made after the specified ID. schema: {} required: false - in: query name: last_id description: Filter the response to payouts made before the specified ID. schema: {} required: false - in: query name: date_min description: Filter the response to payouts made inclusively after the specified date. schema: {} required: false - in: query name: date_max description: Filter the response to payouts made inclusively before the specified date. schema: {} required: false - in: query name: date description: Filter the response to payouts made on the specified date. schema: {} required: false - in: query name: status description: Filter the response to payouts made with the specified status. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_shopify_payments_payouts x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/shopify_payments/payouts/{payout_id}.json: get: summary: Shopify Retrieves A Single Payout By Id description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-04 parameters: - in: path name: payout_id required: true schema: type: string description: payout_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_shopify_payments_payouts_param_payout_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/shopify_payments/payouts.json: get: summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-07 parameters: - in: query name: since_id description: Filter the response to payouts made after the specified ID. schema: {} required: false - in: query name: last_id description: Filter the response to payouts made before the specified ID. schema: {} required: false - in: query name: date_min description: Filter the response to payouts made inclusively after the specified date. schema: {} required: false - in: query name: date_max description: Filter the response to payouts made inclusively before the specified date. schema: {} required: false - in: query name: date description: Filter the response to payouts made on the specified date. schema: {} required: false - in: query name: status description: Filter the response to payouts made with the specified status. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_shopify_payments_payouts x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/shopify_payments/payouts/{payout_id}.json: get: summary: Shopify Retrieves A Single Payout By Id description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-07 parameters: - in: path name: payout_id required: true schema: type: string description: payout_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_shopify_payments_payouts_param_payout_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/shopify_payments/payouts.json: get: summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-10 parameters: - in: query name: since_id description: Filter the response to payouts made after the specified ID. schema: {} required: false - in: query name: last_id description: Filter the response to payouts made before the specified ID. schema: {} required: false - in: query name: date_min description: Filter the response to payouts made inclusively after the specified date. schema: {} required: false - in: query name: date_max description: Filter the response to payouts made inclusively before the specified date. schema: {} required: false - in: query name: date description: Filter the response to payouts made on the specified date. schema: {} required: false - in: query name: status description: Filter the response to payouts made with the specified status. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_shopify_payments_payouts x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/shopify_payments/payouts/{payout_id}.json: get: summary: Shopify Retrieves A Single Payout By Id description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-10 parameters: - in: path name: payout_id required: true schema: type: string description: payout_id tags: - Retrieves responses: '200': description: '' operationId: get_shopify_payments_payouts_param_payout_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/shopify_payments/payouts.json: get: summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2021-01 parameters: - in: query name: since_id description: Filter the response to payouts made after the specified ID. schema: {} required: false - in: query name: last_id description: Filter the response to payouts made before the specified ID. schema: {} required: false - in: query name: date_min description: Filter the response to payouts made inclusively after the specified date. schema: {} required: false - in: query name: date_max description: Filter the response to payouts made inclusively before the specified date. schema: {} required: false - in: query name: date description: Filter the response to payouts made on the specified date. schema: {} required: false - in: query name: status description: Filter the response to payouts made with the specified status. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_shopify_payments_payouts x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/shopify_payments/payouts/{payout_id}.json: get: summary: Shopify Retrieves A Single Payout By Id description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2021-01 parameters: - in: path name: payout_id required: true schema: type: string description: payout_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_shopify_payments_payouts_param_payout_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/shopify_payments/payouts.json: get: summary: Shopify Retrieves A List Of All Payouts Ordered By Payout Date description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-unstable parameters: - in: query name: since_id description: Filter the response to payouts made after the specified ID. schema: {} required: false - in: query name: last_id description: Filter the response to payouts made before the specified ID. schema: {} required: false - in: query name: date_min description: Filter the response to payouts made inclusively after the specified date. schema: {} required: false - in: query name: date_max description: Filter the response to payouts made inclusively before the specified date. schema: {} required: false - in: query name: date description: Filter the response to payouts made on the specified date. schema: {} required: false - in: query name: status description: Filter the response to payouts made with the specified status. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_shopify_payments_payouts x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/shopify_payments/payouts/{payout_id}.json: get: summary: Shopify Retrieves A Single Payout By Id description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-unstable parameters: - in: path name: payout_id required: true schema: type: string description: payout_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_shopify_payments_payouts_param_payout_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/shopify_payments/balance/transactions.json: get: summary: Shopify Retrieves A List Of All Balance Transactions Ordered By Processingtime description: https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/transaction#index-2020-01 parameters: - in: query name: since_id description: Filter response to transactions exclusively after the specified ID. schema: {} required: false - in: query name: last_id description: Filter response to transactions exclusively before the specified ID schema: {} required: false - in: query name: test description: Filter response to transactions placed in test mode. schema: {} required: false - in: query name: payout_id description: Filter response to transactions paid out in the specified payout. schema: {} required: false - in: query name: payout_status description: Filter response to transactions with the specified payout status schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_shopify_payments_balance_transactions x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/countries.json: get: summary: Shopify Retrieves A List Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2020-01 parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_countries x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/countries/count.json: get: summary: Shopify Retrieves A Count Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_countries_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/countries/{country_id}.json: get: summary: Shopify Retrieves A Specific County description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#show-2020-01 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_countries_param_country_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/countries.json: get: summary: Shopify Retrieves A List Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2020-04 parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_countries x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/countries/count.json: get: summary: Shopify Retrieves A Count Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_countries_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/countries/{country_id}.json: get: summary: Shopify Retrieves A Specific County description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#show-2020-04 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_countries_param_country_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/countries.json: get: summary: Shopify Retrieves A List Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2020-07 parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_countries x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/countries/count.json: get: summary: Shopify Retrieves A Count Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_countries_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/countries/{country_id}.json: get: summary: Shopify Retrieves A Specific County description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#show-2020-07 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_countries_param_country_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/countries.json: get: summary: Shopify Retrieves A List Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2020-10 parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_countries x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/countries/count.json: get: summary: Shopify Retrieves A Count Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2020-10 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: get_countries_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/countries/{country_id}.json: get: summary: Shopify Retrieves A Specific County description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#show-2020-10 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_countries_param_country_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/countries.json: get: summary: Shopify Retrieves A List Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2021-01 parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_countries x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/countries/count.json: get: summary: Shopify Retrieves A Count Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_countries_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/countries/{country_id}.json: get: summary: Shopify Retrieves A Specific County description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#show-2021-01 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_countries_param_country_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/countries.json: get: summary: Shopify Retrieves A List Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-unstable parameters: - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_countries x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/countries/count.json: get: summary: Shopify Retrieves A Count Of Countries description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_countries_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/countries/{country_id}.json: get: summary: Shopify Retrieves A Specific County description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#show-unstable parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_countries_param_country_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/currencies.json: get: summary: Shopify Retrieves A List Of Currencies Enabled On A Shop description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_currencies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/currencies.json: get: summary: Shopify Retrieves A List Of Currencies Enabled On A Shop description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_currencies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/currencies.json: get: summary: Shopify Retrieves A List Of Currencies Enabled On A Shop description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_currencies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/currencies.json: get: summary: Shopify Retrieves A List Of Currencies Enabled On A Shop description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2020-10 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: get_currencies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/currencies.json: get: summary: Shopify Retrieves A List Of Currencies Enabled On A Shop description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_currencies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/currencies.json: get: summary: Shopify Retrieves A List Of Currencies Enabled On A Shop description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_currencies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/policies.json: get: summary: Shopify Retrieves A List Of The Shop's Policies description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2020-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_policies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/policies.json: get: summary: Shopify Retrieves A List Of The Shop's Policies description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2020-04 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_policies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/policies.json: get: summary: Shopify Retrieves A List Of The Shop's Policies description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2020-07 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_policies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/policies.json: get: summary: Shopify Retrieves A List Of The Shop's Policies description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2020-10 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: get_policies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/policies.json: get: summary: Shopify Retrieves A List Of The Shop's Policies description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2021-01 parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_policies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/policies.json: get: summary: Shopify Retrieves A List Of The Shop's Policies description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-unstable parameters: [] tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_policies x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/countries/{country_id}/provinces.json: get: summary: Shopify Retrieves A List Of Provinces description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2020-01 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_countries_param_country_id_provinces x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/countries/{country_id}/provinces/count.json: get: summary: Shopify Retrieves A Count Of Provinces For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2020-01 parameters: - in: path name: country_id required: true schema: type: string description: country_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_countries_param_country_id_provinces_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/countries/{country_id}/provinces/{province_id}.json: get: summary: Shopify Retrieves A Single Province For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#show-2020-01 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: path name: province_id required: true schema: type: string description: province_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_countries_param_country_id_provinces_param_province_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/countries/{country_id}/provinces.json: get: summary: Shopify Retrieves A List Of Provinces description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2020-04 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_countries_param_country_id_provinces x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/countries/{country_id}/provinces/count.json: get: summary: Shopify Retrieves A Count Of Provinces For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2020-04 parameters: - in: path name: country_id required: true schema: type: string description: country_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_countries_param_country_id_provinces_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/countries/{country_id}/provinces/{province_id}.json: get: summary: Shopify Retrieves A Single Province For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#show-2020-04 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: path name: province_id required: true schema: type: string description: province_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_countries_param_country_id_provinces_param_province_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/countries/{country_id}/provinces.json: get: summary: Shopify Retrieves A List Of Provinces description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2020-07 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_countries_param_country_id_provinces x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/countries/{country_id}/provinces/count.json: get: summary: Shopify Retrieves A Count Of Provinces For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2020-07 parameters: - in: path name: country_id required: true schema: type: string description: country_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_countries_param_country_id_provinces_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/countries/{country_id}/provinces/{province_id}.json: get: summary: Shopify Retrieves A Single Province For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#show-2020-07 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: path name: province_id required: true schema: type: string description: province_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_countries_param_country_id_provinces_param_province_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/countries/{country_id}/provinces.json: get: summary: Shopify Retrieves A List Of Provinces description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2020-10 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_countries_param_country_id_provinces x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/countries/{country_id}/provinces/count.json: get: summary: Shopify Retrieves A Count Of Provinces For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2020-10 parameters: - in: path name: country_id required: true schema: type: string description: country_id tags: - Retrieves responses: '200': description: '' operationId: get_countries_param_country_id_provinces_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/countries/{country_id}/provinces/{province_id}.json: get: summary: Shopify Retrieves A Single Province For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#show-2020-10 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: path name: province_id required: true schema: type: string description: province_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_countries_param_country_id_provinces_param_province_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/countries/{country_id}/provinces.json: get: summary: Shopify Retrieves A List Of Provinces description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2021-01 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_countries_param_country_id_provinces x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/countries/{country_id}/provinces/count.json: get: summary: Shopify Retrieves A Count Of Provinces For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2021-01 parameters: - in: path name: country_id required: true schema: type: string description: country_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_countries_param_country_id_provinces_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/countries/{country_id}/provinces/{province_id}.json: get: summary: Shopify Retrieves A Single Province For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#show-2021-01 parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: path name: province_id required: true schema: type: string description: province_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_countries_param_country_id_provinces_param_province_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/countries/{country_id}/provinces.json: get: summary: Shopify Retrieves A List Of Provinces description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-unstable parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of fields names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_countries_param_country_id_provinces x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/countries/{country_id}/provinces/count.json: get: summary: Shopify Retrieves A Count Of Provinces For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-unstable parameters: - in: path name: country_id required: true schema: type: string description: country_id tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_countries_param_country_id_provinces_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/countries/{country_id}/provinces/{province_id}.json: get: summary: Shopify Retrieves A Single Province For A Country description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#show-unstable parameters: - in: path name: country_id required: true schema: type: string description: country_id - in: path name: province_id required: true schema: type: string description: province_id - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_countries_param_country_id_provinces_param_province_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/shop.json: get: summary: Shopify Retrieves The Shop's Configuration description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-01 parameters: - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_shop x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/shop.json: get: summary: Shopify Retrieves The Shop's Configuration description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-04 parameters: - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_shop x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/shop.json: get: summary: Shopify Retrieves The Shop's Configuration description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-07 parameters: - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_shop x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/shop.json: get: summary: Shopify Retrieves The Shop's Configuration description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-10 parameters: - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_shop x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/shop.json: get: summary: Shopify Retrieves The Shop's Configuration description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2021-01 parameters: - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_shop x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/shop.json: get: summary: Shopify Retrieves The Shop's Configuration description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-unstable parameters: - in: query name: fields description: A comma-separated list of fields to include in the response. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_shop x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/tender_transactions.json: get: summary: Shopify Retrieves A List Of Tender Transactions description: https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-2020-01 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Retrieve only transactions after the specified ID. schema: {} required: false - in: query name: processed_at_min description: Show tender transactions processed_at or after the specified date. schema: {} required: false - in: query name: processed_at_max description: Show tender transactions processed_at or before the specified date. schema: {} required: false - in: query name: processed_at description: Show tender transactions processed at the specified date. schema: {} required: false - in: query name: order description: Show tender transactions ordered by processed_at in ascending or descending order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202001_get_tender_transactions x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/tender_transactions.json: get: summary: Shopify Retrieves A List Of Tender Transactions description: https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-2020-04 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Retrieve only transactions after the specified ID. schema: {} required: false - in: query name: processed_at_min description: Show tender transactions processed_at or after the specified date. schema: {} required: false - in: query name: processed_at_max description: Show tender transactions processed_at or before the specified date. schema: {} required: false - in: query name: processed_at description: Show tender transactions processed at the specified date. schema: {} required: false - in: query name: order description: Show tender transactions ordered by processed_at in ascending or descending order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202004_get_tender_transactions x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/tender_transactions.json: get: summary: Shopify Retrieves A List Of Tender Transactions description: https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-2020-07 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Retrieve only transactions after the specified ID. schema: {} required: false - in: query name: processed_at_min description: Show tender transactions processed_at or after the specified date. schema: {} required: false - in: query name: processed_at_max description: Show tender transactions processed_at or before the specified date. schema: {} required: false - in: query name: processed_at description: Show tender transactions processed at the specified date. schema: {} required: false - in: query name: order description: Show tender transactions ordered by processed_at in ascending or descending order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202007_get_tender_transactions x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/tender_transactions.json: get: summary: Shopify Retrieves A List Of Tender Transactions description: https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-2020-10 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Retrieve only transactions after the specified ID. schema: {} required: false - in: query name: processed_at_min description: Show tender transactions processed_at or after the specified date. schema: {} required: false - in: query name: processed_at_max description: Show tender transactions processed_at or before the specified date. schema: {} required: false - in: query name: processed_at description: Show tender transactions processed at the specified date. schema: {} required: false - in: query name: order description: Show tender transactions ordered by processed_at in ascending or descending order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: get_tender_transactions x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/tender_transactions.json: get: summary: Shopify Retrieves A List Of Tender Transactions description: https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-2021-01 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Retrieve only transactions after the specified ID. schema: {} required: false - in: query name: processed_at_min description: Show tender transactions processed_at or after the specified date. schema: {} required: false - in: query name: processed_at_max description: Show tender transactions processed_at or before the specified date. schema: {} required: false - in: query name: processed_at description: Show tender transactions processed at the specified date. schema: {} required: false - in: query name: order description: Show tender transactions ordered by processed_at in ascending or descending order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_202101_get_tender_transactions x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/tender_transactions.json: get: summary: Shopify Retrieves A List Of Tender Transactions description: https://shopify.dev/docs/admin-api/rest/reference/tendertransaction#index-unstable parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: since_id description: Retrieve only transactions after the specified ID. schema: {} required: false - in: query name: processed_at_min description: Show tender transactions processed_at or after the specified date. schema: {} required: false - in: query name: processed_at_max description: Show tender transactions processed_at or before the specified date. schema: {} required: false - in: query name: processed_at description: Show tender transactions processed at the specified date. schema: {} required: false - in: query name: order description: Show tender transactions ordered by processed_at in ascending or descending order. schema: {} required: false tags: - Retrieves responses: '200': description: '' operationId: deprecated_unstable_get_tender_transactions x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true components: securitySchemes: AccessToken: type: apiKey name: X-Shopify-Access-Token in: header description: Access token obtained via OAuth