Beta Order Item Photo

Description

order-photo
Base Image

An order photo.

To get the event to which the photo belongs, see .links.event.

To get the photo from which this order photo is derived, see .links.event-photo.

To get a display URL for this photo, see .displayUrl.

Properties

Property Description
created read-only
string
date-time

The creation date of the image.
displayUrl nullable read-only
object
Image Display Url

Display URLs for this image.
filesize read-only
integer

The original filesize of the image (in bytes).
height read-only
integer

The height in pixels of the image.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
lastReplaced nullable read-only
string
date-time

The date on which the photo was last replaced, or null if it has never been replaced.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
mimeType nullable read-only
string

The image file MIME type.
name
string
  • ≤ 250 characters

The original filename of the image.
type
string
enum
  • order-photo

The type of object represented.
width read-only
integer

The width in pixels of the image.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "An order photo.\n\nTo get the event to which the photo belongs, see `.links.event`.\n\nTo get the photo from which this order photo is derived, see\n`.links.event-photo`.\n\nTo get a display URL for this photo, see `.displayUrl`.",
  "properties": {
    "created": {
      "description": "The creation date of the image.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "displayUrl": {
      "allOf": [
        {
          "description": "Display URLs for this image.",
          "nullable": true,
          "readOnly": true
        },
        {
          "$ref": "#/components/schemas/ImageDisplayUrl"
        }
      ]
    },
    "filesize": {
      "description": "The original filesize of the image (in bytes).",
      "example": 18452563,
      "readOnly": true,
      "type": "integer"
    },
    "height": {
      "description": "The height in pixels of the image.",
      "example": 3000,
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "lastReplaced": {
      "description": "The date on which the photo was last replaced, or `null` if it\nhas never been replaced.",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "mimeType": {
      "description": "The image file MIME type.",
      "example": "image/jpeg",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "description": "The original filename of the image.",
      "example": "my-file.jpg",
      "maxLength": 250,
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "order-photo"
      ],
      "type": "string"
    },
    "width": {
      "description": "The width in pixels of the image.",
      "example": 2400,
      "readOnly": true,
      "type": "integer"
    }
  },
  "title": "Order Item Photo",
  "type": "object",
  "x-beta": true
}
Order Item Photo