Etsy · JSON Structure

Webhooks Order Paid Payload Structure

OrderPaidPayload schema from Etsy Open API v3 Webhooks

Type: Properties: 0
MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

OrderPaidPayload is a JSON Structure definition published by Etsy. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-structure/webhooks-order-paid-payload-structure.json",
  "name": "OrderPaidPayload",
  "description": "OrderPaidPayload schema from Etsy Open API v3 Webhooks",
  "allOf": [
    {
      "$ref": "#/components/schemas/WebhookEnvelope"
    },
    {
      "type": "object",
      "properties": {
        "event_type": {
          "type": "string",
          "enum": [
            "order.paid"
          ]
        },
        "resource_url": {
          "type": "uri",
          "description": "Receipt resource URL. Per the documented example, this points\nat `https://api.etsy.com/v3/application/shops/{shop_id}/receipts/{receipt_id}`."
        }
      }
    }
  ]
}