Shopify Risk API

The Risk API from Shopify — 12 operation(s) for risk.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

shopify-risk-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Shopify Admin REST About Risk 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: Risk
paths:
  /admin/api/2020-01/orders/{order_id}/risks.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    message: This order came from an anonymous proxy
                    recommendation: cancel
                    score: 1
                    source: External
                    cause_cancel: true
                    display: true
                summary: Create an order risk showing a fraud risk for proxy detection
      summary: Shopify Creates An Order Risk For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_orders_param_order_id_risks
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json:
    get:
      summary: Shopify Retrieves A Single Order Risk By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Order Risk For An Order                                            You Cannot Delete An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_delete_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/orders/{order_id}/risks.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    message: This order came from an anonymous proxy
                    recommendation: cancel
                    score: 1
                    source: External
                    cause_cancel: true
                    display: true
                summary: Create an order risk showing a fraud risk for proxy detection
      summary: Shopify Creates An Order Risk For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-04
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_orders_param_order_id_risks
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json:
    get:
      summary: Shopify Retrieves A Single Order Risk By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-04
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Order Risk For An Order                                            You Cannot Delete An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_delete_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/orders/{order_id}/risks.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    message: This order came from an anonymous proxy
                    recommendation: cancel
                    score: 1
                    source: External
                    cause_cancel: true
                    display: true
                summary: Create an order risk showing a fraud risk for proxy detection
      summary: Shopify Creates An Order Risk For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-07
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_orders_param_order_id_risks
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json:
    get:
      summary: Shopify Retrieves A Single Order Risk By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-07
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Order Risk For An Order                                            You Cannot Delete An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_delete_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/orders/{order_id}/risks.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    message: This order came from an anonymous proxy
                    recommendation: cancel
                    score: 1
                    source: External
                    cause_cancel: true
                    display: true
                summary: Create an order risk showing a fraud risk for proxy detection
      summary: Shopify Creates An Order Risk For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-10
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: create_orders_param_order_id_risks
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json:
    get:
      summary: Shopify Retrieves A Single Order Risk By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-10
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: get_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Order Risk For An Order                                            You Cannot Delete An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: delete_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/orders/{order_id}/risks.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    message: This order came from an anonymous proxy
                    recommendation: cancel
                    score: 1
                    source: External
                    cause_cancel: true
                    display: true
                summary: Create an order risk showing a fraud risk for proxy detection
      summary: Shopify Creates An Order Risk For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2021-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_orders_param_order_id_risks
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json:
    get:
      summary: Shopify Retrieves A Single Order Risk By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2021-01
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Order Risk For An Order                                            You Cannot Delete An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_delete_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/orders/{order_id}/risks.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    message: This order came from an anonymous proxy
                    recommendation: cancel
                    score: 1
                    source: External
                    cause_cancel: true
                    display: true
                summary: Create an order risk showing a fraud risk for proxy detection
      summary: Shopify Creates An Order Risk For An Order
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-unstable
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_orders_param_order_id_risks
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/orders/{order_id}/risks/{risk_id}.json:
    get:
      summary: Shopify Retrieves A Single Order Risk By Its Id
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-unstable
      parameters:
      - in: path
        name: order_id
        required: true
        schema:
          type: string
        description: order_id
      - in: path
        name: risk_id
        required: true
        schema:
          type: string
        description: risk_id
      tags:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  risk:
                    id: 284138680
                    message: After further review, this is a legitimate order
                    recommendation: accept
                    source: External
                    cause_cancel: false
                    score: 0
                summary: Update an existing order risk for an order
      summary: Shopify Updates An Order Risk                                            You Cannot Modify An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_orders_param_order_id_risks_param_risk_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes An Order Risk For An Order                                            You Cannot Delete An Order Risk That Was Created By Another Application
      description: https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-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:
      - Risk
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_delete_orders_param_order_id_risks_param_risk_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