{ "opencollection": "1.0.0", "info": { "name": "Shopify Admin REST About Identifiers API", "version": "2025-01" }, "request": { "auth": { "type": "apikey", "key": "X-Shopify-Access-Token", "value": "{{X-Shopify-Access-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Identifiers", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Event By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/events/:event_id.json", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "event_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/events/event#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Inventory Item By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/inventory_items/:inventory_item_id.json", "params": [ { "name": "inventory_item_id", "value": "", "type": "path", "description": "inventory_item_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Location By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/locations/:location_id.json", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "location_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-01" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-04" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-07" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-10" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2021-01" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Metafield From A Resource By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#show-unstable" }, { "info": { "name": "Shopify Deletes A Metafield By Its Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/metafields/:metafield_id.json", "params": [ { "name": "metafield_id", "value": "", "type": "path", "description": "metafield_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-unstable" }, { "info": { "name": "Shopify Get A Single Blog By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/blogs/:blog_id.json", "params": [ { "name": "blog_id", "value": "", "type": "path", "description": "blog_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Comment By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/comments/:comment_id.json", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "comment_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/online-store/comment#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Order Risk By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/orders/:order_id/risks/:risk_id.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "risk_id", "value": "", "type": "path", "description": "risk_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-unstable" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Gift Card By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/gift_cards/:gift_card_id.json", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "gift_card_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-unstable" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Specific Collect By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-unstable" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-01" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-04" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-07" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-10" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2021-01" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-unstable" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-01" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-04" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-07" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-10" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2021-01" }, { "info": { "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/checkouts/:token/payments.json", "params": [ { "name": "token", "value": "", "type": "path", "description": "token" }, { "name": "amount\n required", "value": "", "type": "query", "description": "The amount of the payment." }, { "name": "request_details\n required", "value": "", "type": "query", "description": "The details of the request, including the following attributes:\n \n ip_address: The IP address of the customer.\n accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n user_agent: The user agent string for the customer's device." }, { "name": "session_id\n required", "value": "", "type": "query", "description": "A session ID provided by the card vault when creating a payment session." }, { "name": "unique_token\n required", "value": "", "type": "query", "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests." } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-unstable" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Carrier Service By Its Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/carrier_services/:carrier_service_id.json", "params": [ { "name": "carrier_service_id", "value": "", "type": "path", "description": "carrier_service_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-unstable" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-01" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-04" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-07" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-10" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2021-01" }, { "info": { "name": "Shopify Cancel A Fulfillment For A Specific Order Id", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/orders/:order_id/fulfillments/:fulfillment_id/cancel.json", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "order_id" }, { "name": "fulfillment_id", "value": "", "type": "path", "description": "fulfillment_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-unstable" }, { "info": { "name": "Shopify Retrieves A Single Dispute By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/shopify_payments/disputes/:dispute_id.json", "params": [ { "name": "dispute_id", "value": "", "type": "path", "description": "dispute_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/dispute#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Payout By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/shopify_payments/payouts/:payout_id.json", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "payout_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-unstable" } ] } ], "bundled": true }