Skip to content

OrderRefundEvent ​

Type: schema

Description ​

A refund as the payment.refund.* events carry it: the order's refund (OrderRefund), with the payment it pays back and the provider it is paid through.

TypeScript Definition ​

typescript
OrderRefundEvent: {components["schemas"]["OrderRefund"] & {
            /** @description The provider the refund is paid through: the payment gateway of the payment it pays back, the store's bank-transfer provider, or `loyalty-point` for loyalty points. */
            payment_gateway?: string
}

Component References ​

ReferenceResolves To
components["schemas"]["OrderRefund"]OrderRefund

OpenAPI Schema ​

json
{
  "title": "OrderRefundEvent",
  "description": "A refund as the `payment.refund.*` events carry it: the order's refund (`OrderRefund`), with the payment it pays back and the provider it is paid through.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/OrderRefundEvent",
    "description": "API reference for the OrderRefundEvent schema"
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/OrderRefund"
    },
    {
      "type": "object",
      "properties": {
        "payment_gateway": {
          "description": "The provider the refund is paid through: the payment gateway of the payment it pays back, the store's bank-transfer provider, or `loyalty-point` for loyalty points.",
          "type": "string"
        },
        "payment_request_number": {
          "description": "The `request_number` of the payment it pays back; `null` when it isn't tied to one payment (e.g. a bank-transfer refund).",
          "type": [
            "string",
            "null"
          ]
        },
        "is_manual_refund": {
          "description": "`true` for a refund recorded manually instead of processed by Commerce Engine.",
          "type": "boolean"
        }
      }
    }
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: