BigCommerce · Schema

store/order/refund/created

This webhook is triggered when a refund is submitted against an order. ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", "producer": "stores/{store_hash}", "scope": "store/order/refund/created", "hash": "352e4afc6dd3fc85ea26bfdf3f91852604d57528", "data": { "type": "order", "id": 250, "refund": { "refund_id": 3 } } } ```

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/store_order_refund_created",
  "title": "store/order/refund/created",
  "description": "This webhook is triggered when a refund is submitted against an order.\n\n```json filename=\"Example callback object\" showLineNumbers\n{\n  \"created_at\": 1561482670,\n  \"store_id\": \"1025646\",\n  \"producer\": \"stores/{store_hash}\",\n  \"scope\": \"store/order/refund/created\",\n  \"hash\": \"352e4afc6dd3fc85ea26bfdf3f91852604d57528\",\n  \"data\": {\n    \"type\": \"order\",\n    \"id\": 250,\n    \"refund\": {\n      \"refund_id\": 3\n    }\n  }\n}\n```",
  "x-examples": {},
  "allOf": [
    {
      "$ref": "#/components/schemas/webhook_callback_base"
    },
    {
      "description": "A lightweight description of the event that triggered the webhook. Will vary depending on the event registered.",
      "properties": {
        "data": {
          "type": "object",
          "description": "A lightweight description of the event that triggered the webhook. Will vary depending on the event registered.",
          "properties": {
            "type": {
              "type": "string",
              "description": "The type will always be `order`.",
              "example": "order"
            },
            "id": {
              "type": "integer",
              "description": "ID of the order.",
              "example": 250
            },
            "refund": {
              "type": "object",
              "properties": {
                "refund_id": {
                  "type": "integer",
                  "description": "ID of the refund submitted against the order.",
                  "example": 3
                }
              }
            }
          }
        }
      }
    }
  ],
  "x-tags": [
    "created"
  ],
  "type": "object",
  "x-internal": false
}