E-commerce template

Return Slip

RMA return slip with return id + barcode slot, drop-off instructions, and per-item refund breakdown. Designed for in-box printing.

Pro, Business & Scale plansLanguage: en
slug: return-slipRendered with sample data
01

Quick start

Reference the template by its slug and pass your data. The same call works from any language; pick whichever fits your stack. Replace $KAMY_API_KEY with a key from the dashboard.

curl
curl https://kamy.dev/api/v1/render \
  -H "Authorization: Bearer $KAMY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "templateSlug": "return-slip",
    "data": {
      "returnId": "RMA-99214",
      "orderNumber": "1042",
      "returnDate": "2026-04-29",
      "currency": "USD",
      "store": {
        "name": "Northwind Coffee",
        "supportEmail": "[email protected]",
        "supportPhone": "+1 (212) 555-0142"
      },
      "customer": {
        "name": "Maya Tran",
        "address": "248 Bedford Avenue, Apt 4B, Brooklyn, NY 11211"
      },
      "returnAddress": {
        "name": "Northwind Coffee — Returns",
        "lines": "Northwind Coffee\nAttn: Returns\n400 Wythe Avenue\nBrooklyn, NY 11249"
      },
      "items": [
        {
          "name": "Cold-brew bottle · 32 oz · 6-pack",
          "sku": "CB-32-6",
          "quantity": 1,
          "reason": "Damaged in transit",
          "refundAmount": 28
        }
      ],
      "totalRefund": 28,
      // …
    }
  }'
node.js
import { Kamy } from "@kamydev/sdk";

const kamy = new Kamy({ apiKey: process.env.KAMY_API_KEY! });

const { url } = await kamy.render({
  templateSlug: "return-slip",
  data: {
    "returnId": "RMA-99214",
    "orderNumber": "1042",
    "returnDate": "2026-04-29",
    "currency": "USD",
    "store": {
      "name": "Northwind Coffee",
      "supportEmail": "[email protected]",
      "supportPhone": "+1 (212) 555-0142"
    },
    "customer": {
      "name": "Maya Tran",
      "address": "248 Bedford Avenue, Apt 4B, Brooklyn, NY 11211"
    },
    "returnAddress": {
      "name": "Northwind Coffee — Returns",
      "lines": "Northwind Coffee\nAttn: Returns\n400 Wythe Avenue\nBrooklyn, NY 11249"
    },
    "items": [
      {
        "name": "Cold-brew bottle · 32 oz · 6-pack",
        "sku": "CB-32-6",
        "quantity": 1,
        "reason": "Damaged in transit",
        "refundAmount": 28
      }
    ],
    "totalRefund": 28,
    // …
  },
});

console.log(url); // signed URL, valid for 1 hour
python
import os, requests

resp = requests.post(
    "https://kamy.dev/api/v1/render",
    headers={"Authorization": f"Bearer {os.environ['KAMY_API_KEY']}"},
    json={
        "templateSlug": "return-slip",
        "data": {
          "returnId": "RMA-99214",
          "orderNumber": "1042",
          "returnDate": "2026-04-29",
          "currency": "USD",
          "store": {
            "name": "Northwind Coffee",
            "supportEmail": "[email protected]",
            "supportPhone": "+1 (212) 555-0142"
          },
          "customer": {
            "name": "Maya Tran",
            "address": "248 Bedford Avenue, Apt 4B, Brooklyn, NY 11211"
          },
          "returnAddress": {
            "name": "Northwind Coffee — Returns",
            "lines": "Northwind Coffee\nAttn: Returns\n400 Wythe Avenue\nBrooklyn, NY 11249"
          },
          "items": [
            {
              "name": "Cold-brew bottle · 32 oz · 6-pack",
              "sku": "CB-32-6",
              "quantity": 1,
              "reason": "Damaged in transit",
              "refundAmount": 28
            }
          ],
          "totalRefund": 28,
          // …
        },
    },
)
resp.raise_for_status()
print(resp.json()["url"])
02

Sample payload

The full sample data the live preview above renders from. Use it as a starting point for your own integration — every field is optional except those marked required in the schema below.

json
{
  "returnId": "RMA-99214",
  "orderNumber": "1042",
  "returnDate": "2026-04-29",
  "currency": "USD",
  "store": {
    "name": "Northwind Coffee",
    "supportEmail": "[email protected]",
    "supportPhone": "+1 (212) 555-0142"
  },
  "customer": {
    "name": "Maya Tran",
    "address": "248 Bedford Avenue, Apt 4B, Brooklyn, NY 11211"
  },
  "returnAddress": {
    "name": "Northwind Coffee — Returns",
    "lines": "Northwind Coffee\nAttn: Returns\n400 Wythe Avenue\nBrooklyn, NY 11249"
  },
  "items": [
    {
      "name": "Cold-brew bottle · 32 oz · 6-pack",
      "sku": "CB-32-6",
      "quantity": 1,
      "reason": "Damaged in transit",
      "refundAmount": 28
    }
  ],
  "totalRefund": 28,
  "refundMethod": "Original payment method (Visa ending 4242)",
  "carrier": "USPS",
  "dropoffLocation": "any USPS retail location"
}
03

JSON Schema

The render endpoint validates your payload against this JSON Schema before queuing the render. Validation errors come back with HTTP 400 and a VALIDATION_FAILED code listing every offending path.

json
{
  "type": "object",
  "required": [
    "returnId",
    "orderNumber",
    "returnDate",
    "store",
    "customer",
    "items",
    "totalRefund",
    "currency"
  ],
  "properties": {
    "returnId": {
      "type": "string",
      "minLength": 1
    },
    "orderNumber": {
      "type": "string",
      "minLength": 1
    },
    "returnDate": {
      "type": "string"
    },
    "currency": {
      "type": "string",
      "minLength": 3,
      "maxLength": 3
    },
    "store": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "supportEmail": {
          "type": "string",
          "format": "email"
        },
        "supportPhone": {
          "type": "string"
        }
      }
    },
    "customer": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "address": {
          "type": "string"
        }
      }
    },
    "returnAddress": {
      "type": "object",
      "required": [
        "name",
        "lines"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "lines": {
          "type": "string"
        }
      }
    },
    "items": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "required": [
          "name",
          "quantity",
          "reason",
          "refundAmount"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "sku": {
            "type": "string"
          },
          "quantity": {
            "type": "number"
          },
          "reason": {
            "type": "string"
          },
          "refundAmount": {
            "type": "number"
          }
        }
      }
    },
    "totalRefund": {
      "type": "number"
    },
    "refundMethod": {
      "type": "string"
    },
    "carrier": {
      "type": "string"
    },
    "dropoffLocation": {
      "type": "string"
    }
  }
}
Return Slip template — Kamy PDF API — Kamy