An order item object. Orders contain items.
Property | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
albumPath read-only |
The string path through the album hierarchy to the album containing the photo this item is based on. Captured at order creation time. |
||||||||||||
altDisplayName |
The (optional) alternate display name for this item. |
||||||||||||
approved read-only |
Flag indicating whether this item has been marked as |
||||||||||||
approvedDate nullable read-only |
The date the item was approved. |
||||||||||||
clientCropData required nullable read-only |
Customer selected crop data, overwrites default crop if provided. |
||||||||||||
clientNotes read-only |
Notes provided by the customer when they added the item to the order. |
||||||||||||
created nullable read-only |
The date on which this item was added to the order. |
||||||||||||
cropData required nullable |
Defaults to center crop, overwritten by
|
||||||||||||
digitalDownloadPixels read-only |
Max pixel dimension of the digital download. |
||||||||||||
digitalDownloadTypeId read-only |
Ref ID noting the digital download type. |
||||||||||||
eventAlbumId |
The ID of the album containing the photo(s) making up this order item. |
||||||||||||
filterType |
Filter applied to the photo for creation of this item. |
||||||||||||
fulfillmentType read-only |
Slugs description of the order item fulfillment type. |
||||||||||||
groupId read-only |
The UUID of the price sheet categorization group to which this item belongs. |
||||||||||||
groupName read-only |
The name of the price sheet categorization group to which this item belongs. |
||||||||||||
id read-only |
The identifier for this order item, a UUID. |
||||||||||||
isAlbumFiles read-only |
Flags whether the object is comprised of all photo files in the album. |
||||||||||||
isAllFiles read-only |
Flags whether the object is comprised of all photo files in the event. |
||||||||||||
isLowPhotoDpi nullable read-only |
Flag to indicate whether the photo DPI is beneath the threshold for low DPI ( |
||||||||||||
labCatalogProductId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||
labProductRetailPrice read-only |
The retail price of this item in the lab catalog. |
||||||||||||
name |
The human readable item name. Should be derived from the names of the item group and add on group names. |
||||||||||||
origin |
Indicates the origin of the item in the order. Default is |
||||||||||||
originalPrice read-only |
Pre-discount retail price of the item. |
||||||||||||
photo read-only |
The item's photo. May return an order-photo or an event-photo resource. |
||||||||||||
photoDpi nullable read-only |
The photo DPI for this item, function of photo's pixel dimensions and item size. |
||||||||||||
photoId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||
price read-only |
The item price. This value is calculated as the sum of each item add-on's price. |
||||||||||||
quantity |
Number of instances of this item appearing in the order. |
||||||||||||
size read-only |
The item size, expressed in terms of x1, y1, x2, y2 (top left, bottom right, in inches). |
||||||||||||
status read-only |
The item status. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "An order item object. Orders contain items.",
"properties": {
"albumPath": {
"description": "The string path through the album hierarchy to the album containing\nthe photo this item is based on. Captured at order creation time.",
"readOnly": true,
"type": "string"
},
"altDisplayName": {
"description": "The (optional) alternate display name for this item.",
"type": "string"
},
"approved": {
"description": "Flag indicating whether this item has been marked as `approved`\nwithin the context of this order. Items are individually approved in\nthe order.",
"readOnly": true,
"type": "boolean"
},
"approvedDate": {
"description": "The date the item was approved.",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"clientCropData": {
"allOf": [
{
"description": "Customer selected crop data, overwrites default crop if provided.",
"title": "Customer-selected Crop"
},
{
"$ref": "#/components/schemas/OrderItem/properties/cropData"
}
],
"readOnly": true
},
"clientNotes": {
"description": "Notes provided by the customer when they added the item to the\norder.",
"readOnly": true,
"type": "string"
},
"created": {
"description": "The date on which this item was added to the order.",
"example": "2018-04-24T16:20:00+0000",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"cropData": {
"description": "Defaults to center crop, overwritten by `clientCropData` if present.",
"nullable": true,
"properties": {
"maxX": {
"description": "Horizontal position of bottom right corner of crop, expressed as\na percentage (Float, 1-100), from left edge (x = 0) of image.",
"format": "float",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"maxY": {
"description": "Vertical position of bottom right corner of crop, expressed as a\npercentage (Float, 1-100), from top edge (y = 0) of image.",
"format": "float",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"minX": {
"description": "Horizontal position of top left corner of crop, expressed as a\npercentage (Float, 1-100), from left edge (x = 0) of image.",
"format": "float",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"minY": {
"description": "Vertical position of top left corner of crop, expressed as a\npercentage (Float, 1-100), from top edge (y = 0) of image.",
"format": "float",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"type": {
"description": "The type of object represented.",
"enum": [
"crop-data"
],
"type": "string"
}
},
"required": [
"maxX",
"maxY",
"minX",
"minY"
],
"title": "Default Crop",
"type": "object"
},
"digitalDownloadPixels": {
"description": "Max pixel dimension of the digital download.",
"readOnly": true,
"type": "integer"
},
"digitalDownloadTypeId": {
"description": "Ref ID noting the digital download type.",
"readOnly": true,
"type": "integer"
},
"eventAlbumId": {
"description": "The ID of the album containing the photo(s) making up this order item.",
"type": "integer"
},
"filterType": {
"description": "Filter applied to the photo for creation of this item.",
"enum": [
"none",
"black-and-white",
"sepia"
],
"type": "string"
},
"fulfillmentType": {
"description": "Slugs description of the order item fulfillment type.",
"enum": [
"lab",
"digital",
"self"
],
"readOnly": true,
"type": "string"
},
"groupId": {
"description": "The UUID of the price sheet categorization group to which this item\nbelongs.",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"readOnly": true,
"type": "string"
},
"groupName": {
"description": "The name of the price sheet categorization group to which this item\nbelongs.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The identifier for this order item, a UUID.",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"readOnly": true,
"type": "string"
},
"isAlbumFiles": {
"description": "Flags whether the object is comprised of all photo files in the\nalbum.",
"readOnly": true,
"type": "boolean"
},
"isAllFiles": {
"description": "Flags whether the object is comprised of all photo files in the\nevent.",
"readOnly": true,
"type": "boolean"
},
"isLowPhotoDpi": {
"description": "Flag to indicate whether the photo DPI is beneath the threshold for low\nDPI (`100`). `null` if the DPI cannot be determined.",
"nullable": true,
"readOnly": true,
"type": "boolean"
},
"labCatalogProductId": {
"$ref": "#/components/schemas/Id",
"description": "The ID referencing the item(s) in the lab catalog. During order item creation, values from the lab\ncatalog product will be used to fill elements of the order item."
},
"labProductRetailPrice": {
"description": "The retail price of this item in the lab catalog.",
"readOnly": true,
"type": "number"
},
"name": {
"description": "The human readable item name. Should be derived from the names of\nthe item group and add on group names.",
"type": "string"
},
"origin": {
"default": "client",
"description": "Indicates the origin of the item in the order. Default is `client`\nindicating a client/customer added the item to the order. `studio`\nindicates that the item was added to the order by the studio.",
"enum": [
"studio",
"client"
],
"example": "client",
"type": "string"
},
"originalPrice": {
"description": "Pre-discount retail price of the item.",
"readOnly": true,
"type": "number"
},
"photo": {
"description": "The item's photo. May return an order-photo or an event-photo\nresource.",
"oneOf": [
{
"$ref": "#/components/schemas/OrderItemPhoto"
},
{
"$ref": "#/components/schemas/EventPhoto"
}
],
"readOnly": true,
"type": "object"
},
"photoDpi": {
"description": "The photo DPI for this item, function of photo's pixel dimensions and item\nsize. `null` if the DPI cannot be determined.",
"nullable": true,
"readOnly": true,
"type": "number"
},
"photoId": {
"$ref": "#/components/schemas/Id",
"description": "The record identifier of the photo on which this item is based."
},
"price": {
"description": "The item price. This value is calculated as the sum of each item\nadd-on's price.",
"readOnly": true,
"type": "number"
},
"quantity": {
"description": "Number of instances of this item appearing in the order.",
"type": "integer"
},
"size": {
"description": "The item size, expressed in terms of x1, y1, x2, y2 (top left,\nbottom right, in inches).",
"readOnly": true,
"type": "string"
},
"status": {
"description": "The item status.",
"enum": [
"active",
"deleted"
],
"readOnly": true,
"type": "string"
}
},
"required": [
"labCatalogProductId",
"photoId",
"eventId"
],
"title": "OrderItem",
"type": "object",
"x-beta": true
}