openapi: 3.1.0 info: title: Shopify Admin REST About Identifiers 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: Identifiers paths: /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: - Identifiers responses: '200': description: '' operationId: deprecated_202001_get_events_param_event_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202004_get_events_param_event_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202007_get_events_param_event_id 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: - Identifiers responses: '200': description: '' operationId: get_events_param_event_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202101_get_events_param_event_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_unstable_get_events_param_event_id 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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/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: - Identifiers responses: '200': description: '' operationId: deprecated_202001_get_locations_param_location_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202004_get_locations_param_location_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202007_get_locations_param_location_id 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: - Identifiers responses: '200': description: '' operationId: get_locations_param_location_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202101_get_locations_param_location_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_unstable_get_locations_param_location_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202001_get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes A Metafield By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-01 parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id tags: - Identifiers responses: '200': description: '' operationId: deprecated_202001_delete_metafields_param_metafield_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202004_get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes A Metafield By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-04 parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id tags: - Identifiers responses: '200': description: '' operationId: deprecated_202004_delete_metafields_param_metafield_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202007_get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes A Metafield By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-07 parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id tags: - Identifiers responses: '200': description: '' operationId: deprecated_202007_delete_metafields_param_metafield_id 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: - Identifiers responses: '200': description: '' operationId: get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes A Metafield By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-10 parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id tags: - Identifiers responses: '200': description: '' operationId: delete_metafields_param_metafield_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202101_get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes A Metafield By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2021-01 parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id tags: - Identifiers responses: '200': description: '' operationId: deprecated_202101_delete_metafields_param_metafield_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_unstable_get_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true delete: summary: Shopify Deletes A Metafield By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-unstable parameters: - in: path name: metafield_id required: true schema: type: string description: metafield_id tags: - Identifiers responses: '200': description: '' operationId: deprecated_unstable_delete_metafields_param_metafield_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/blogs/{blog_id}.json: get: summary: Shopify Get A Single Blog By Its Id description: https://shopify.dev/docs/admin-api/rest/reference/online-store/blog#show-2020-01 parameters: - in: path name: blog_id required: true schema: type: string description: blog_id - in: query name: fields description: comma-separated list of fields to include in the response schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_202001_get_blogs_param_blog_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202001_get_comments_param_comment_id 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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/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: - Identifiers responses: '200': description: '' operationId: deprecated_202001_get_gift_cards_param_gift_card_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202004_get_gift_cards_param_gift_card_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202007_get_gift_cards_param_gift_card_id 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: - Identifiers responses: '200': description: '' operationId: get_gift_cards_param_gift_card_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202101_get_gift_cards_param_gift_card_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_unstable_get_gift_cards_param_gift_card_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202001_get_collects_param_collect_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202004_get_collects_param_collect_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202007_get_collects_param_collect_id 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: - Identifiers responses: '200': description: '' operationId: get_collects_param_collect_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_202101_get_collects_param_collect_id 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: - Identifiers responses: '200': description: '' operationId: deprecated_unstable_get_collects_param_collect_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/products/{product_id}/images/{image_id}.json: get: summary: Shopify Get A Single Product Image By Id description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-01 parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: path name: image_id required: true schema: type: string description: image_id - in: query name: fields description: comma-separated list of fields to include in the response schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_202001_get_products_param_product_id_images_param_image_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/products/{product_id}/images/{image_id}.json: get: summary: Shopify Get A Single Product Image By Id description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-04 parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: path name: image_id required: true schema: type: string description: image_id - in: query name: fields description: comma-separated list of fields to include in the response schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_202004_get_products_param_product_id_images_param_image_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/products/{product_id}/images/{image_id}.json: get: summary: Shopify Get A Single Product Image By Id description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-07 parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: path name: image_id required: true schema: type: string description: image_id - in: query name: fields description: comma-separated list of fields to include in the response schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_202007_get_products_param_product_id_images_param_image_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/products/{product_id}/images/{image_id}.json: get: summary: Shopify Get A Single Product Image By Id description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-10 parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: path name: image_id required: true schema: type: string description: image_id - in: query name: fields description: comma-separated list of fields to include in the response schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: get_products_param_product_id_images_param_image_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/products/{product_id}/images/{image_id}.json: get: summary: Shopify Get A Single Product Image By Id description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2021-01 parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: path name: image_id required: true schema: type: string description: image_id - in: query name: fields description: comma-separated list of fields to include in the response schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_202101_get_products_param_product_id_images_param_image_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/products/{product_id}/images/{image_id}.json: get: summary: Shopify Get A Single Product Image By Id description: https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-unstable parameters: - in: path name: product_id required: true schema: type: string description: product_id - in: path name: image_id required: true schema: type: string description: image_id - in: query name: fields description: comma-separated list of fields to include in the response schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_unstable_get_products_param_product_id_images_param_image_id x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/checkouts/{token}/payments.json: post: requestBody: content: application/json: schema: {} examples: example1: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-2b883b5dbab7059e unique_token: client-side-idempotency-token summary: Create an authorization using a valid session_id stored in the vault example2: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-a61a334b946b55fb unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors example3: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-an_invalid_session_id unique_token: client-side-idempotency-token summary: Creating an authorization with an invalid session ID fails and returns errors example4: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-d0436243a47a3418 unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session can fail for various reasons summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-01 parameters: - in: path name: token required: true schema: type: string description: token - in: query name: "amount\n required" description: The amount of the payment. schema: {} required: false - in: query name: "request_details\n required" 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." schema: {} required: false - in: query name: "session_id\n required" description: A session ID provided by the card vault when creating a payment session. schema: {} required: false - in: query name: "unique_token\n required" description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests. schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_202001_create_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/checkouts/{token}/payments.json: post: requestBody: content: application/json: schema: {} examples: example1: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-2b883b5dbab7059e unique_token: client-side-idempotency-token summary: Create an authorization using a valid session_id stored in the vault example2: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-a61a334b946b55fb unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors example3: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-an_invalid_session_id unique_token: client-side-idempotency-token summary: Creating an authorization with an invalid session ID fails and returns errors example4: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-d0436243a47a3418 unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session can fail for various reasons summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-04 parameters: - in: path name: token required: true schema: type: string description: token - in: query name: "amount\n required" description: The amount of the payment. schema: {} required: false - in: query name: "request_details\n required" 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." schema: {} required: false - in: query name: "session_id\n required" description: A session ID provided by the card vault when creating a payment session. schema: {} required: false - in: query name: "unique_token\n required" description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests. schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_202004_create_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/checkouts/{token}/payments.json: post: requestBody: content: application/json: schema: {} examples: example1: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-2b883b5dbab7059e unique_token: client-side-idempotency-token summary: Create an authorization using a valid session_id stored in the vault example2: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-a61a334b946b55fb unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors example3: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-an_invalid_session_id unique_token: client-side-idempotency-token summary: Creating an authorization with an invalid session ID fails and returns errors example4: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-d0436243a47a3418 unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session can fail for various reasons summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-07 parameters: - in: path name: token required: true schema: type: string description: token - in: query name: "amount\n required" description: The amount of the payment. schema: {} required: false - in: query name: "request_details\n required" 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." schema: {} required: false - in: query name: "session_id\n required" description: A session ID provided by the card vault when creating a payment session. schema: {} required: false - in: query name: "unique_token\n required" description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests. schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_202007_create_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/checkouts/{token}/payments.json: post: requestBody: content: application/json: schema: {} examples: example1: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-2b883b5dbab7059e unique_token: client-side-idempotency-token summary: Create an authorization using a valid session_id stored in the vault example2: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-a61a334b946b55fb unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors example3: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-an_invalid_session_id unique_token: client-side-idempotency-token summary: Creating an authorization with an invalid session ID fails and returns errors example4: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-d0436243a47a3418 unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session can fail for various reasons summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-10 parameters: - in: path name: token required: true schema: type: string description: token - in: query name: "amount\n required" description: The amount of the payment. schema: {} required: false - in: query name: "request_details\n required" 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." schema: {} required: false - in: query name: "session_id\n required" description: A session ID provided by the card vault when creating a payment session. schema: {} required: false - in: query name: "unique_token\n required" description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests. schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: create_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/checkouts/{token}/payments.json: post: requestBody: content: application/json: schema: {} examples: example1: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-2b883b5dbab7059e unique_token: client-side-idempotency-token summary: Create an authorization using a valid session_id stored in the vault example2: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-a61a334b946b55fb unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors example3: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-an_invalid_session_id unique_token: client-side-idempotency-token summary: Creating an authorization with an invalid session ID fails and returns errors example4: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-d0436243a47a3418 unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session can fail for various reasons summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2021-01 parameters: - in: path name: token required: true schema: type: string description: token - in: query name: "amount\n required" description: The amount of the payment. schema: {} required: false - in: query name: "request_details\n required" 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." schema: {} required: false - in: query name: "session_id\n required" description: A session ID provided by the card vault when creating a payment session. schema: {} required: false - in: query name: "unique_token\n required" description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests. schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_202101_create_checkouts_param_token_payments x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/checkouts/{token}/payments.json: post: requestBody: content: application/json: schema: {} examples: example1: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-2b883b5dbab7059e unique_token: client-side-idempotency-token summary: Create an authorization using a valid session_id stored in the vault example2: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-a61a334b946b55fb unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session ID but an invalid credit card number fails and returns errors example3: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '419.49' session_id: global-an_invalid_session_id unique_token: client-side-idempotency-token summary: Creating an authorization with an invalid session ID fails and returns errors example4: value: payment: request_details: ip_address: 123.1.1.1 accept_language: en-US,en;q=0.8,fr;q=0.6 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36 amount: '398.00' session_id: global-d0436243a47a3418 unique_token: client-side-idempotency-token summary: Creating an authorization with a valid session can fail for various reasons summary: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-unstable parameters: - in: path name: token required: true schema: type: string description: token - in: query name: "amount\n required" description: The amount of the payment. schema: {} required: false - in: query name: "request_details\n required" 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." schema: {} required: false - in: query name: "session_id\n required" description: A session ID provided by the card vault when creating a payment session. schema: {} required: false - in: query name: "unique_token\n required" description: A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests. schema: {} required: false tags: - Identifiers responses: '200': description: '' operationId: deprecated_unstable_create_checkouts_param_token_payments 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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-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 tags: - Identifiers responses: '200': description: '' operationId: deprecated_202001_create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-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 tags: - Identifiers responses: '200': description: '' operationId: deprecated_202004_create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-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 tags: - Identifiers responses: '200': description: '' operationId: deprecated_202007_create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-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 tags: - Identifiers responses: '200': description: '' operationId: create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-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 tags: - Identifiers responses: '200': description: '' operationId: deprecated_202101_create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json: post: requestBody: content: application/json: schema: {} examples: example1: value: {} summary: Cancel a fulfillment for a specific order ID summary: Shopify Cancel A Fulfillment For A Specific Order Id description: https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-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 tags: - Identifiers responses: '200': description: '' operationId: deprecated_unstable_create_orders_param_order_id_fulfillments_param_fulfillment_id_cancel 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: - Identifiers responses: '200': description: '' operationId: deprecated_202001_get_shopify_payments_disputes_param_dispute_id 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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers 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/{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: - Identifiers responses: '200': description: '' operationId: deprecated_unstable_get_shopify_payments_payouts_param_payout_id 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