Sendoso Send

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/sendoso/schemas/send",
  "title": "Sendoso Send",
  "description": "A Sendoso send — a gift, e-gift, swag item, or direct mail sent to a recipient",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique send identifier"
    },
    "status": {
      "type": "string",
      "enum": ["pending", "processing", "shipped", "delivered", "failed", "cancelled"],
      "description": "Current lifecycle status of the send"
    },
    "recipient": {
      "$ref": "#/$defs/RecipientRef",
      "description": "Recipient contact information"
    },
    "item": {
      "$ref": "#/$defs/InventoryItemRef",
      "description": "The gift or product being sent"
    },
    "message": {
      "type": "string",
      "maxLength": 500,
      "description": "Personalized message included with the send"
    },
    "tracking_number": {
      "type": ["string", "null"],
      "description": "Carrier tracking number once the item has shipped"
    },
    "tracking_url": {
      "type": ["string", "null"],
      "format": "uri",
      "description": "URL to track the shipment"
    },
    "estimated_delivery": {
      "type": ["string", "null"],
      "format": "date",
      "description": "Estimated delivery date"
    },
    "cost": {
      "type": "number",
      "format": "float",
      "minimum": 0,
      "description": "Send cost in USD including item price and shipping"
    },
    "crm_id": {
      "type": ["string", "null"],
      "description": "External CRM object ID (Salesforce contact/lead/opportunity, HubSpot contact, etc.)"
    },
    "crm_type": {
      "type": ["string", "null"],
      "enum": ["contact", "lead", "account", "opportunity", null],
      "description": "CRM object type associated with this send"
    },
    "team_id": {
      "type": "string",
      "description": "Sendoso team that owns and is billed for this send"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the send was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the send was last updated"
    }
  },
  "required": ["id", "status", "recipient", "item", "team_id", "created_at"],
  "$defs": {
    "RecipientRef": {
      "type": "object",
      "properties": {
        "id": {"type": "string"},
        "first_name": {"type": "string"},
        "last_name": {"type": "string"},
        "email": {"type": "string", "format": "email"}
      },
      "required": ["id", "first_name", "last_name"]
    },
    "InventoryItemRef": {
      "type": "object",
      "properties": {
        "id": {"type": "string"},
        "name": {"type": "string"},
        "type": {
          "type": "string",
          "enum": ["physical", "egift", "swag", "direct_mail", "charity"]
        }
      },
      "required": ["id", "name"]
    }
  }
}