Beta Orders

The billing address for this order.

clientNote nullable

string

Client submitted note, added by the client/customer when the order was placed.

clientSelectedShippingId nullable

string

Shipping option that the client chose at checkout. This field is readOnly in update requests.

combinedOrder read-only

boolean

Indicates whether this order was created by combining multiple orders.

created read-only

string

date-time

The creation date of this order.

currencyCode read-only

string

Currency code for the currency all order amounts are expressed in.

currencySymbol read-only

string

Currency symbol of the currency all order amounts are expressed in.

customStatus nullable

string

A custom order status provided by the studio

customerCropSelected read-only

boolean

Whether this order contains items having a customer defined crop.

customerEmail

string

The email address of the customer having billing responsibility for this order.

customerName nullable read-only

string

The name of the customer having billing responsibility for this order. Read-only because it's a property of the customer's address, not the Order object itself.

customerPhone nullable

either

string

number

The phone number submitted with the order.

digitalDownloadDate nullable read-only

string

date-time

Important: this property returns mock data. See example. The date on which the digital order items were downloaded by the customer. Null if fulfillmentType does not contain digital or if the digital items have not yet been downloaded.

digitalSentDate read-only

string

date-time

Important: this property returns mock data. See example. The date on which the digital order items were sent to the customer. Null if fulfillmentType does not contain digital or if the digital items are not yet sent.

digitalStatus nullable read-only

string

enum

awaiting-studio
awaiting-payment
sent

String slug representation of the current digital status of this order. Null if fulfillmentType does not contain digital. 'awaiting-studio' = awaiting studio approval. 'awaiting-payment' = not released because payment is incomplete. 'sent' = the download URL has been emailed to the customer.

eventId nullable deprecated

integer

The identifier for the event this order originates from. This can only be null if the order is part of a combined order. This field is read-only in update requests.

eventName nullable read-only deprecated

string

The name of the event this order originates from.

fulfillmentTypes read-only

string[]

enum

lab
digital
self

Array of slugs descriptions of the order fulfillment types. An order may have one or more fulfillment types. Determined by the items in the order.

grandTotal read-only

number

The order grand total value, in the currency selected by the order's currencyCode. Grand total is calculated by adding the item price for each item and item option, subtracting discounts and applying tax. Grand total is fixed to the time when order was placed by the customer.

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

isPaid read-only deprecated

boolean

The isPaid property is true if the order is fully paid or has been marked as paid through the Studio Panel.

This property is deprecated and may be removed in the future.

itemCount read-only

number

The number of items on this order.

labApprovedByStudioDate nullable read-only

string

date-time

The date on which this order was approved for processing by lab.

labCatalogId nullable

integer

Identifier of the lab catalog containing the items which comprise this order. This field is readOnly in update requests.

labId nullable read-only

number

The id of the lab fulfilling the order.

labName nullable read-only deprecated

string

Deprecated. Please use the lab-catalog link relation to obtain lab information related to this order.

labReceipts read-only

object[]

Collection of records of lab receipts of orders.

Property	Description
id read-only	`integer` The record identifier for the receipt.
labOrderNumber read-only	`string` The order number created by the lab for processing this SP order.
receiptDate read-only	`string` date-time The date when this order was accepted by the lab, the receipt date.

labShipments read-only

object[]

Lab shipments associated with this order

Property	Description
created read-only	`string` date-time The creation date of this shipment record.
id read-only	`integer` The record identifier for the shipment.
labOrderNumber read-only	`string` The order number created by the lab for processing this SP order.
labReference read-only	`string` Text field used by lab to reference the unique identifier the order was submitted to the lab with. Optional reference value that may be used by the lab.
shipDate read-only	`string` date-time The date when this shipment was reported as `shipped`.
trackingId read-only	`string` The shipment tracking ID, used for tracking the shipment.
trackingUrl read-only	`string` The shipment tracking URL, used for tracking the shipment.

labStatus nullable read-only

string

enum

pending-copy-of-originals
copying-originals
pending-studio-confirmation
submit-to-lab
submitted-to-lab
lab-received
lab-completed
canceled

The slug string name of the current status of lab fulfilled orders. Null if order is studio-fulfilled. Alternately referred to as lab progress. This is null for any order not having a fulfillmentType containing lab.

labSubmittedDate nullable read-only

string

date-time

The date on which this order's lab fulfilled items were submitted to the lab for fulfillment.

links required read-only

object

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.

orderStatus nullable

string

enum

archived
canceled
completed
deleted
new
on-hold
pending
printing
shipped

The slug string name of the current status of this order. See customStatus for description of interaction with that field. @TODO: Determine whether the change history of lab statuses is required.

origin read-only

string

enum

client
studio

Indicates whether the order was placed by the studio or by their client.

parentOrderId nullable read-only deprecated

number

Deprecated. Please use the parent link relation to obtain parent order information related to this order.

paymentStatus read-only

string

enum

unpaid
partially-paid
paid

The slug string name of the current payment status of this order. When the Order contains payments having a sum of not more than $0, the paymentStatus is unpaid. When the sum of an order's payments are less than the order's grandTotal, the paymentStatus is 'partially-paid'. When the sum of all order payments equals (or exceeds) the order's grandTotal, the paymentStatus is 'paid'.

pickupAtStudio

boolean

Flag indicating whether the order will be picked up at the studio in lieu of being shipped. Applies to self fulfilled items or items drop shipped from lab to studio.

profitReleaseDate nullable read-only

string

date-time

The date and time when order funds were released to the studio. Null if not applicable.

profitReleased read-only

boolean

Flag indicating whether the order's profit has been released. Funds are released to studio after 5 days, at which point this will be true. Null if not applicable, only applicable when payment gateway is ShootProof Payments.

retouchRequested beta nullable read-only

boolean

Indicates whether the customer has requested retouching on the order.

roesOrderId nullable read-only

string

The identifier for the order as recognized by ROES, if applicable.

salesTax read-only

number

Amount of sales tax applied to this order.

salesTaxOnDigitals read-only

boolean

Flag indicating whether or not sales tax is applied to digital download items in this order. As indicated on the price sheet at the time the order was placed.

salesTaxOnShipping read-only

boolean

Flag indicating whether or not sales tax is applied to the shipping amount. As indicated on the price sheet at the time the order was placed.

salesTaxPercent read-only

number

The percentage used to calculate sales tax amount.

salesTaxStateId nullable read-only

string

The 2 character code identifying the US state for which sales tax is being applied.

salesTaxTitle nullable read-only

string

The human readable string labeling the sales tax amount. This is the sales tax label in use on the price sheet at the time the order was placed.

shippingAddress required nullable

address

The address this order should be shipped to.

shippingCharge

number

Amount charged by the studio to the customer for shipping of this order.

studioNote nullable

string

Studio submitted note, added by the studio owner/user when updating an order.

tags

string[]

Tags describing this order.

type

string

enum

order

The model type for the response object.

vatNumber nullable read-only

string

VAT number from the price sheet at the time the order was placed.

vatTotal read-only

number

The amount of VAT calculated for and applied to this order.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

Property	Description
currentPage	`integer` The current page of results returned.
rows	`integer` The number of rows returned per page for the current result set.
totalItems	`integer` The total number of items in the result set. This may be affected by active search/filter parameters.
totalPages	`integer` The total number of pages in the result set. This is affected by the `rows` parameter (`totalItems / rows == totalPages`).

type

string

enum

order-collection

Type

The model type for the list response object.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/OrderCollection"
        }
      }
    },
    "description": "Orders list response."
  }
}

Beta Creates a new order for the current brand.

Creates a new order, responding with the newly created object.

post

/studio/brand/{brandId}/order

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The order object to create.

application/vnd.shootproof+json

Property	Description
billingAddress required nullable	`address` Address The billing address for this order.
clientNote nullable	`string` Client submitted note, added by the client/customer when the order was placed.
clientSelectedShippingId nullable	`string` Shipping option that the client chose at checkout. This field is readOnly in update requests.
customStatus nullable	`string` A custom order status provided by the studio
customerEmail	`string` email The email address of the customer having billing responsibility for this order.
customerPhone nullable	either `string` or `number` The phone number submitted with the order.
eventId nullable deprecated	`integer` The identifier for the event this order originates from. This can only be null if the order is part of a combined order. This field is read-only in update requests.
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.
labCatalogId nullable	`integer` Identifier of the lab catalog containing the items which comprise this order. This field is readOnly in update requests.
orderStatus nullable	`string` enum archived canceled completed deleted new on-hold pending printing shipped The slug string name of the current status of this order. See `customStatus` for description of interaction with that field. @TODO: Determine whether the change history of lab statuses is required.
pickupAtStudio	`boolean` Flag indicating whether the order will be picked up at the studio in lieu of being shipped. Applies to self fulfilled items or items drop shipped from lab to studio.
shippingAddress required nullable	`address` Address The address this order should be shipped to.
shippingCharge	`number` Amount charged by the studio to the customer for shipping of this order.
studioNote nullable	`string` Studio submitted note, added by the studio owner/user when updating an order.
tags	`string[]` Tags describing this order.
type	`string` enum order The model type for the response object.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/Order"
      }
    }
  },
  "description": "The order object to create.",
  "required": true
}

Receiving the response

`201 Created`

The successfully-created order.

Headers

Header	Description
Location	`string` uri The URL to the newly-created order.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

adjustment nullable read-only

number

Amount of adjustment applied to this order. Positive number which is always subtracted from subtotal. Derived from the sum of discount amounts.

balanceDue read-only

number

The amount of the balance presently due on this order. Should equal the sum of grand total and adjustments minus payments. This is a calculated property. @TODO: remove?

billingAddress required nullable

address

The billing address for this order.

clientNote nullable

string

Client submitted note, added by the client/customer when the order was placed.

clientSelectedShippingId nullable

string

Shipping option that the client chose at checkout. This field is readOnly in update requests.

combinedOrder read-only

boolean

Indicates whether this order was created by combining multiple orders.

created read-only

string

date-time

The creation date of this order.

currencyCode read-only

string

Currency code for the currency all order amounts are expressed in.

currencySymbol read-only

string

Currency symbol of the currency all order amounts are expressed in.

customStatus nullable

string

A custom order status provided by the studio

customerCropSelected read-only

boolean

Whether this order contains items having a customer defined crop.

customerEmail

string

The email address of the customer having billing responsibility for this order.

customerName nullable read-only

string

The name of the customer having billing responsibility for this order. Read-only because it's a property of the customer's address, not the Order object itself.

customerPhone nullable

either

string

number

The phone number submitted with the order.

digitalDownloadDate nullable read-only

string

date-time

digitalSentDate read-only

string

date-time

digitalStatus nullable read-only

string

enum

awaiting-studio
awaiting-payment
sent

eventId nullable deprecated

integer

The identifier for the event this order originates from. This can only be null if the order is part of a combined order. This field is read-only in update requests.

eventName nullable read-only deprecated

string

The name of the event this order originates from.

fulfillmentTypes read-only

string[]

enum

lab
digital
self

Array of slugs descriptions of the order fulfillment types. An order may have one or more fulfillment types. Determined by the items in the order.

grandTotal read-only

number

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

isPaid read-only deprecated

boolean

The isPaid property is true if the order is fully paid or has been marked as paid through the Studio Panel.

This property is deprecated and may be removed in the future.

itemCount read-only

number

The number of items on this order.

labApprovedByStudioDate nullable read-only

string

date-time

The date on which this order was approved for processing by lab.

labCatalogId nullable

integer

Identifier of the lab catalog containing the items which comprise this order. This field is readOnly in update requests.

labId nullable read-only

number

The id of the lab fulfilling the order.

labName nullable read-only deprecated

string

Deprecated. Please use the lab-catalog link relation to obtain lab information related to this order.

labReceipts read-only

object[]

Collection of records of lab receipts of orders.

Property	Description
id read-only	`integer` The record identifier for the receipt.
labOrderNumber read-only	`string` The order number created by the lab for processing this SP order.
receiptDate read-only	`string` date-time The date when this order was accepted by the lab, the receipt date.

labShipments read-only

object[]

Lab shipments associated with this order

Property	Description
created read-only	`string` date-time The creation date of this shipment record.
id read-only	`integer` The record identifier for the shipment.
labOrderNumber read-only	`string` The order number created by the lab for processing this SP order.
labReference read-only	`string` Text field used by lab to reference the unique identifier the order was submitted to the lab with. Optional reference value that may be used by the lab.
shipDate read-only	`string` date-time The date when this shipment was reported as `shipped`.
trackingId read-only	`string` The shipment tracking ID, used for tracking the shipment.
trackingUrl read-only	`string` The shipment tracking URL, used for tracking the shipment.

labStatus nullable read-only

string

enum

pending-copy-of-originals
copying-originals
pending-studio-confirmation
submit-to-lab
submitted-to-lab
lab-received
lab-completed
canceled

labSubmittedDate nullable read-only

string

date-time

The date on which this order's lab fulfilled items were submitted to the lab for fulfillment.

links required read-only

object

orderStatus nullable

string

enum

archived
canceled
completed
deleted
new
on-hold
pending
printing
shipped

The slug string name of the current status of this order. See customStatus for description of interaction with that field. @TODO: Determine whether the change history of lab statuses is required.

origin read-only

string

enum

client
studio

Indicates whether the order was placed by the studio or by their client.

parentOrderId nullable read-only deprecated

number

Deprecated. Please use the parent link relation to obtain parent order information related to this order.

paymentStatus read-only

string

enum

unpaid
partially-paid
paid

pickupAtStudio

boolean

Flag indicating whether the order will be picked up at the studio in lieu of being shipped. Applies to self fulfilled items or items drop shipped from lab to studio.

profitReleaseDate nullable read-only

string

date-time

The date and time when order funds were released to the studio. Null if not applicable.

profitReleased read-only

boolean

retouchRequested beta nullable read-only

boolean

Indicates whether the customer has requested retouching on the order.

roesOrderId nullable read-only

string

The identifier for the order as recognized by ROES, if applicable.

salesTax read-only

number

Amount of sales tax applied to this order.

salesTaxOnDigitals read-only

boolean

Flag indicating whether or not sales tax is applied to digital download items in this order. As indicated on the price sheet at the time the order was placed.

salesTaxOnShipping read-only

boolean

Flag indicating whether or not sales tax is applied to the shipping amount. As indicated on the price sheet at the time the order was placed.

salesTaxPercent read-only

number

The percentage used to calculate sales tax amount.

salesTaxStateId nullable read-only

string

The 2 character code identifying the US state for which sales tax is being applied.

salesTaxTitle nullable read-only

string

The human readable string labeling the sales tax amount. This is the sales tax label in use on the price sheet at the time the order was placed.

shippingAddress required nullable

address

The address this order should be shipped to.

shippingCharge

number

Amount charged by the studio to the customer for shipping of this order.

studioNote nullable

string

Studio submitted note, added by the studio owner/user when updating an order.

tags

string[]

Tags describing this order.

type

string

enum

order

The model type for the response object.

vatNumber nullable read-only

string

VAT number from the price sheet at the time the order was placed.

vatTotal read-only

number

The amount of VAT calculated for and applied to this order.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "201": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Order"
        }
      }
    },
    "description": "The successfully-created order.",
    "headers": {
      "Location": {
        "description": "The URL to the newly-created order.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Beta Removes an order.

Changes order status to deleted.

delete

/studio/brand/{brandId}/order/{orderId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

204
Schema

`204 No Content`

Successful deletion response.

OpenAPI Schema

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

{
  "204": {
    "description": "Successful deletion response."
  }
}

Beta Returns a single order by ID.

Returns an order with the given ID. If the ID is not found, returns a 404 response.

get

/studio/brand/{brandId}/order/{orderId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`200 OK`

An order

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

adjustment nullable read-only

number

Amount of adjustment applied to this order. Positive number which is always subtracted from subtotal. Derived from the sum of discount amounts.

balanceDue read-only

number

The amount of the balance presently due on this order. Should equal the sum of grand total and adjustments minus payments. This is a calculated property. @TODO: remove?

billingAddress required nullable

address

The billing address for this order.

clientNote nullable

string

Client submitted note, added by the client/customer when the order was placed.

clientSelectedShippingId nullable

string

Shipping option that the client chose at checkout. This field is readOnly in update requests.

combinedOrder read-only

boolean

Indicates whether this order was created by combining multiple orders.

created read-only

string

date-time

The creation date of this order.

currencyCode read-only

string

Currency code for the currency all order amounts are expressed in.

currencySymbol read-only

string

Currency symbol of the currency all order amounts are expressed in.

customStatus nullable

string

A custom order status provided by the studio

customerCropSelected read-only

boolean

Whether this order contains items having a customer defined crop.

customerEmail

string

The email address of the customer having billing responsibility for this order.

customerName nullable read-only

string

The name of the customer having billing responsibility for this order. Read-only because it's a property of the customer's address, not the Order object itself.

customerPhone nullable

either

string

number

The phone number submitted with the order.

digitalDownloadDate nullable read-only

string

date-time

digitalSentDate read-only

string

date-time

digitalStatus nullable read-only

string

enum

awaiting-studio
awaiting-payment
sent

eventId nullable deprecated

integer

The identifier for the event this order originates from. This can only be null if the order is part of a combined order. This field is read-only in update requests.

eventName nullable read-only deprecated

string

The name of the event this order originates from.

fulfillmentTypes read-only

string[]

enum

lab
digital
self

Array of slugs descriptions of the order fulfillment types. An order may have one or more fulfillment types. Determined by the items in the order.

grandTotal read-only

number

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

isPaid read-only deprecated

boolean

The isPaid property is true if the order is fully paid or has been marked as paid through the Studio Panel.

This property is deprecated and may be removed in the future.

itemCount read-only

number

The number of items on this order.

labApprovedByStudioDate nullable read-only

string

date-time

The date on which this order was approved for processing by lab.

labCatalogId nullable

integer

Identifier of the lab catalog containing the items which comprise this order. This field is readOnly in update requests.

labId nullable read-only

number

The id of the lab fulfilling the order.

labName nullable read-only deprecated

string

Deprecated. Please use the lab-catalog link relation to obtain lab information related to this order.

labReceipts read-only

object[]

Collection of records of lab receipts of orders.

Property	Description
id read-only	`integer` The record identifier for the receipt.
labOrderNumber read-only	`string` The order number created by the lab for processing this SP order.
receiptDate read-only	`string` date-time The date when this order was accepted by the lab, the receipt date.

labShipments read-only

object[]

Lab shipments associated with this order

Property	Description
created read-only	`string` date-time The creation date of this shipment record.
id read-only	`integer` The record identifier for the shipment.
labOrderNumber read-only	`string` The order number created by the lab for processing this SP order.
labReference read-only	`string` Text field used by lab to reference the unique identifier the order was submitted to the lab with. Optional reference value that may be used by the lab.
shipDate read-only	`string` date-time The date when this shipment was reported as `shipped`.
trackingId read-only	`string` The shipment tracking ID, used for tracking the shipment.
trackingUrl read-only	`string` The shipment tracking URL, used for tracking the shipment.

labStatus nullable read-only

string

enum

pending-copy-of-originals
copying-originals
pending-studio-confirmation
submit-to-lab
submitted-to-lab
lab-received
lab-completed
canceled

labSubmittedDate nullable read-only

string

date-time

The date on which this order's lab fulfilled items were submitted to the lab for fulfillment.

links required read-only

object

orderStatus nullable

string

enum

archived
canceled
completed
deleted
new
on-hold
pending
printing
shipped

The slug string name of the current status of this order. See customStatus for description of interaction with that field. @TODO: Determine whether the change history of lab statuses is required.

origin read-only

string

enum

client
studio

Indicates whether the order was placed by the studio or by their client.

parentOrderId nullable read-only deprecated

number

Deprecated. Please use the parent link relation to obtain parent order information related to this order.

paymentStatus read-only

string

enum

unpaid
partially-paid
paid

pickupAtStudio

boolean

Flag indicating whether the order will be picked up at the studio in lieu of being shipped. Applies to self fulfilled items or items drop shipped from lab to studio.

profitReleaseDate nullable read-only

string

date-time

The date and time when order funds were released to the studio. Null if not applicable.

profitReleased read-only

boolean

retouchRequested beta nullable read-only

boolean

Indicates whether the customer has requested retouching on the order.

roesOrderId nullable read-only

string

The identifier for the order as recognized by ROES, if applicable.

salesTax read-only

number

Amount of sales tax applied to this order.

salesTaxOnDigitals read-only

boolean

Flag indicating whether or not sales tax is applied to digital download items in this order. As indicated on the price sheet at the time the order was placed.

salesTaxOnShipping read-only

boolean

Flag indicating whether or not sales tax is applied to the shipping amount. As indicated on the price sheet at the time the order was placed.

salesTaxPercent read-only

number

The percentage used to calculate sales tax amount.

salesTaxStateId nullable read-only

string

The 2 character code identifying the US state for which sales tax is being applied.

salesTaxTitle nullable read-only

string

The human readable string labeling the sales tax amount. This is the sales tax label in use on the price sheet at the time the order was placed.

shippingAddress required nullable

address

The address this order should be shipped to.

shippingCharge

number

Amount charged by the studio to the customer for shipping of this order.

studioNote nullable

string

Studio submitted note, added by the studio owner/user when updating an order.

tags

string[]

Tags describing this order.

type

string

enum

order

The model type for the response object.

vatNumber nullable read-only

string

VAT number from the price sheet at the time the order was placed.

vatTotal read-only

number

The amount of VAT calculated for and applied to this order.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Order"
        }
      }
    },
    "description": "An order"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Beta Partially updates an order.

Updates the provided fields on the order, except those indicated as readOnly.

patch

/studio/brand/{brandId}/order/{orderId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The order object to update. Only provide those properties that need updating.

application/vnd.shootproof+json

Property Description

billingAddress required nullable

address

The billing address for this order.

clientNote nullable

string

Client submitted note, added by the client/customer when the order was placed.

customStatus nullable

string

A custom order status provided by the studio

customerEmail

string

The email address of the customer having billing responsibility for this order.

customerPhone nullable

either

string

number

The phone number submitted with the order.

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

notes

object

Order notes.

Property	Description
clientNote read-only	`string` Client submitted note, added by the client/customer when the order was placed.
studioNote	`string` Studio submitted note, added by the studio owner/user when updating an order.

orderStatus nullable

string

enum

archived
canceled
completed
deleted
new
on-hold
pending
printing
shipped

The slug string name of the current status of this order. See customStatus for description of interaction with that field. @TODO: Determine whether the change history of lab statuses is required.

pickupAtStudio

boolean

Flag indicating whether the order will be picked up at the studio in lieu of being shipped. Applies to self fulfilled items or items drop shipped from lab to studio.

shippingAddress required nullable

address

The address this order should be shipped to.

shippingCharge

number

Amount charged by the studio to the customer for shipping of this order.

studioNote nullable

string

Studio submitted note, added by the studio owner/user when updating an order.

tags

string[]

Tags describing this order.

type

string

enum

order

The model type for the response object.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/OrderInUpdate"
      }
    }
  },
  "description": "The order object to update. Only provide those properties that need\nupdating.",
  "required": true
}

Receiving the response

`200 OK`

The successfully-updated order.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

adjustment nullable read-only

number

Amount of adjustment applied to this order. Positive number which is always subtracted from subtotal. Derived from the sum of discount amounts.

balanceDue read-only

number

The amount of the balance presently due on this order. Should equal the sum of grand total and adjustments minus payments. This is a calculated property. @TODO: remove?

billingAddress required nullable

address

The billing address for this order.

clientNote nullable

string

Client submitted note, added by the client/customer when the order was placed.

clientSelectedShippingId nullable

string

Shipping option that the client chose at checkout. This field is readOnly in update requests.

combinedOrder read-only

boolean

Indicates whether this order was created by combining multiple orders.

created read-only

string

date-time

The creation date of this order.

currencyCode read-only

string

Currency code for the currency all order amounts are expressed in.

currencySymbol read-only

string

Currency symbol of the currency all order amounts are expressed in.

customStatus nullable

string

A custom order status provided by the studio

customerCropSelected read-only

boolean

Whether this order contains items having a customer defined crop.

customerEmail

string

The email address of the customer having billing responsibility for this order.

customerName nullable read-only

string

The name of the customer having billing responsibility for this order. Read-only because it's a property of the customer's address, not the Order object itself.

customerPhone nullable

either

string

number

The phone number submitted with the order.

digitalDownloadDate nullable read-only

string

date-time

digitalSentDate read-only

string

date-time

digitalStatus nullable read-only

string

enum

awaiting-studio
awaiting-payment
sent

eventId nullable deprecated

integer

The identifier for the event this order originates from. This can only be null if the order is part of a combined order. This field is read-only in update requests.

eventName nullable read-only deprecated

string

The name of the event this order originates from.

fulfillmentTypes read-only

string[]

enum

lab
digital
self

Array of slugs descriptions of the order fulfillment types. An order may have one or more fulfillment types. Determined by the items in the order.

grandTotal read-only

number

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

isPaid read-only deprecated

boolean

The isPaid property is true if the order is fully paid or has been marked as paid through the Studio Panel.

This property is deprecated and may be removed in the future.

itemCount read-only

number

The number of items on this order.

labApprovedByStudioDate nullable read-only

string

date-time

The date on which this order was approved for processing by lab.

labCatalogId nullable

integer

Identifier of the lab catalog containing the items which comprise this order. This field is readOnly in update requests.

labId nullable read-only

number

The id of the lab fulfilling the order.

labName nullable read-only deprecated

string

Deprecated. Please use the lab-catalog link relation to obtain lab information related to this order.

labReceipts read-only

object[]

Collection of records of lab receipts of orders.

Property	Description
id read-only	`integer` The record identifier for the receipt.
labOrderNumber read-only	`string` The order number created by the lab for processing this SP order.
receiptDate read-only	`string` date-time The date when this order was accepted by the lab, the receipt date.

labShipments read-only

object[]

Lab shipments associated with this order

Property	Description
created read-only	`string` date-time The creation date of this shipment record.
id read-only	`integer` The record identifier for the shipment.
labOrderNumber read-only	`string` The order number created by the lab for processing this SP order.
labReference read-only	`string` Text field used by lab to reference the unique identifier the order was submitted to the lab with. Optional reference value that may be used by the lab.
shipDate read-only	`string` date-time The date when this shipment was reported as `shipped`.
trackingId read-only	`string` The shipment tracking ID, used for tracking the shipment.
trackingUrl read-only	`string` The shipment tracking URL, used for tracking the shipment.

labStatus nullable read-only

string

enum

pending-copy-of-originals
copying-originals
pending-studio-confirmation
submit-to-lab
submitted-to-lab
lab-received
lab-completed
canceled

labSubmittedDate nullable read-only

string

date-time

The date on which this order's lab fulfilled items were submitted to the lab for fulfillment.

links required read-only

object

orderStatus nullable

string

enum

archived
canceled
completed
deleted
new
on-hold
pending
printing
shipped

The slug string name of the current status of this order. See customStatus for description of interaction with that field. @TODO: Determine whether the change history of lab statuses is required.

origin read-only

string

enum

client
studio

Indicates whether the order was placed by the studio or by their client.

parentOrderId nullable read-only deprecated

number

Deprecated. Please use the parent link relation to obtain parent order information related to this order.

paymentStatus read-only

string

enum

unpaid
partially-paid
paid

pickupAtStudio

boolean

Flag indicating whether the order will be picked up at the studio in lieu of being shipped. Applies to self fulfilled items or items drop shipped from lab to studio.

profitReleaseDate nullable read-only

string

date-time

The date and time when order funds were released to the studio. Null if not applicable.

profitReleased read-only

boolean

retouchRequested beta nullable read-only

boolean

Indicates whether the customer has requested retouching on the order.

roesOrderId nullable read-only

string

The identifier for the order as recognized by ROES, if applicable.

salesTax read-only

number

Amount of sales tax applied to this order.

salesTaxOnDigitals read-only

boolean

Flag indicating whether or not sales tax is applied to digital download items in this order. As indicated on the price sheet at the time the order was placed.

salesTaxOnShipping read-only

boolean

Flag indicating whether or not sales tax is applied to the shipping amount. As indicated on the price sheet at the time the order was placed.

salesTaxPercent read-only

number

The percentage used to calculate sales tax amount.

salesTaxStateId nullable read-only

string

The 2 character code identifying the US state for which sales tax is being applied.

salesTaxTitle nullable read-only

string

The human readable string labeling the sales tax amount. This is the sales tax label in use on the price sheet at the time the order was placed.

shippingAddress required nullable

address

The address this order should be shipped to.

shippingCharge

number

Amount charged by the studio to the customer for shipping of this order.

studioNote nullable

string

Studio submitted note, added by the studio owner/user when updating an order.

tags

string[]

Tags describing this order.

type

string

enum

order

The model type for the response object.

vatNumber nullable read-only

string

VAT number from the price sheet at the time the order was placed.

vatTotal read-only

number

The amount of VAT calculated for and applied to this order.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Order"
        }
      }
    },
    "description": "The successfully-updated order."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Beta Sends an email message with the order receipt to a single recipient.

Sends an email receipt with details of the order, items, and transaction(s) to a single recipient. This can be the order customerEmail, or any other valid address. An optional message can be sent with the receipt.

post

/studio/brand/{brandId}/order/{orderId}/email

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The order email object used to send an email message.

application/vnd.shootproof+json

Property	Description
body	`string` ≤ 10000 characters The message to include in the body of the email.
recipientEmails	`string[]` Email address(es) to send the email to. If provided, must be an array of valid email addresses. Optional, but may be required by child schemas.
subject	`string` ≤ 200 characters The subject line for the email message.
type	`string` enum email Type The type of resource represented.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/BasicEmailMessage",
        "description": "An email message to a recipient with a receipt and details about\ntheir order.",
        "type": "object"
      }
    }
  },
  "description": "The order email object used to send an email message.",
  "required": true
}

Receiving the response

`202 Accepted`

Responds with the order on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the order in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

adjustment nullable read-only

number

Amount of adjustment applied to this order. Positive number which is always subtracted from subtotal. Derived from the sum of discount amounts.

balanceDue read-only

number

The amount of the balance presently due on this order. Should equal the sum of grand total and adjustments minus payments. This is a calculated property. @TODO: remove?

billingAddress required nullable

address

The billing address for this order.

clientNote nullable

string

Client submitted note, added by the client/customer when the order was placed.

clientSelectedShippingId nullable

string

Shipping option that the client chose at checkout. This field is readOnly in update requests.

combinedOrder read-only

boolean

Indicates whether this order was created by combining multiple orders.

created read-only

string

date-time

The creation date of this order.

currencyCode read-only

string

Currency code for the currency all order amounts are expressed in.

currencySymbol read-only

string

Currency symbol of the currency all order amounts are expressed in.

customStatus nullable

string

A custom order status provided by the studio

customerCropSelected read-only

boolean

Whether this order contains items having a customer defined crop.

customerEmail

string

The email address of the customer having billing responsibility for this order.

customerName nullable read-only

string

The name of the customer having billing responsibility for this order. Read-only because it's a property of the customer's address, not the Order object itself.

customerPhone nullable

either

string

number

The phone number submitted with the order.

digitalDownloadDate nullable read-only

string

date-time

digitalSentDate read-only

string

date-time

digitalStatus nullable read-only

string

enum

awaiting-studio
awaiting-payment
sent

eventId nullable deprecated

integer

The identifier for the event this order originates from. This can only be null if the order is part of a combined order. This field is read-only in update requests.

eventName nullable read-only deprecated

string

The name of the event this order originates from.

fulfillmentTypes read-only

string[]

enum

lab
digital
self

Array of slugs descriptions of the order fulfillment types. An order may have one or more fulfillment types. Determined by the items in the order.

grandTotal read-only

number

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

isPaid read-only deprecated

boolean

The isPaid property is true if the order is fully paid or has been marked as paid through the Studio Panel.

This property is deprecated and may be removed in the future.

itemCount read-only

number

The number of items on this order.

labApprovedByStudioDate nullable read-only

string

date-time

The date on which this order was approved for processing by lab.

labCatalogId nullable

integer

Identifier of the lab catalog containing the items which comprise this order. This field is readOnly in update requests.

labId nullable read-only

number

The id of the lab fulfilling the order.

labName nullable read-only deprecated

string

Deprecated. Please use the lab-catalog link relation to obtain lab information related to this order.

labReceipts read-only

object[]

Collection of records of lab receipts of orders.

Property	Description
id read-only	`integer` The record identifier for the receipt.
labOrderNumber read-only	`string` The order number created by the lab for processing this SP order.
receiptDate read-only	`string` date-time The date when this order was accepted by the lab, the receipt date.

labShipments read-only

object[]

Lab shipments associated with this order

Property	Description
created read-only	`string` date-time The creation date of this shipment record.
id read-only	`integer` The record identifier for the shipment.
labOrderNumber read-only	`string` The order number created by the lab for processing this SP order.
labReference read-only	`string` Text field used by lab to reference the unique identifier the order was submitted to the lab with. Optional reference value that may be used by the lab.
shipDate read-only	`string` date-time The date when this shipment was reported as `shipped`.
trackingId read-only	`string` The shipment tracking ID, used for tracking the shipment.
trackingUrl read-only	`string` The shipment tracking URL, used for tracking the shipment.

labStatus nullable read-only

string

enum

pending-copy-of-originals
copying-originals
pending-studio-confirmation
submit-to-lab
submitted-to-lab
lab-received
lab-completed
canceled

labSubmittedDate nullable read-only

string

date-time

The date on which this order's lab fulfilled items were submitted to the lab for fulfillment.

links required read-only

object

orderStatus nullable

string

enum

archived
canceled
completed
deleted
new
on-hold
pending
printing
shipped

The slug string name of the current status of this order. See customStatus for description of interaction with that field. @TODO: Determine whether the change history of lab statuses is required.

origin read-only

string

enum

client
studio

Indicates whether the order was placed by the studio or by their client.

parentOrderId nullable read-only deprecated

number

Deprecated. Please use the parent link relation to obtain parent order information related to this order.

paymentStatus read-only

string

enum

unpaid
partially-paid
paid

pickupAtStudio

boolean

Flag indicating whether the order will be picked up at the studio in lieu of being shipped. Applies to self fulfilled items or items drop shipped from lab to studio.

profitReleaseDate nullable read-only

string

date-time

The date and time when order funds were released to the studio. Null if not applicable.

profitReleased read-only

boolean

retouchRequested beta nullable read-only

boolean

Indicates whether the customer has requested retouching on the order.

roesOrderId nullable read-only

string

The identifier for the order as recognized by ROES, if applicable.

salesTax read-only

number

Amount of sales tax applied to this order.

salesTaxOnDigitals read-only

boolean

Flag indicating whether or not sales tax is applied to digital download items in this order. As indicated on the price sheet at the time the order was placed.

salesTaxOnShipping read-only

boolean

Flag indicating whether or not sales tax is applied to the shipping amount. As indicated on the price sheet at the time the order was placed.

salesTaxPercent read-only

number

The percentage used to calculate sales tax amount.

salesTaxStateId nullable read-only

string

The 2 character code identifying the US state for which sales tax is being applied.

salesTaxTitle nullable read-only

string

The human readable string labeling the sales tax amount. This is the sales tax label in use on the price sheet at the time the order was placed.

shippingAddress required nullable

address

The address this order should be shipped to.

shippingCharge

number

Amount charged by the studio to the customer for shipping of this order.

studioNote nullable

string

Studio submitted note, added by the studio owner/user when updating an order.

tags

string[]

Tags describing this order.

type

string

enum

order

The model type for the response object.

vatNumber nullable read-only

string

VAT number from the price sheet at the time the order was placed.

vatTotal read-only

number

The amount of VAT calculated for and applied to this order.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "202": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Order"
        }
      }
    },
    "description": "Responds with the order on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the order in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Beta Lists all order items for the identified order..

Returns a list of all order items for the current order. Query string parameters may be used to affect the response, including pagination, sorting, and filtering.

get

/studio/brand/{brandId}/order/{orderId}/item

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

200
Schema

`200 OK`

Order item list response.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

items

object[]

A collection of resources returned in the current result set.

Property Description

albumPath read-only

string

The string path through the album hierarchy to the album containing the photo this item is based on. Captured at order creation time.

altDisplayName

string

The (optional) alternate display name for this item.

approved read-only

boolean

Flag indicating whether this item has been marked as approved within the context of this order. Items are individually approved in the order.

approvedDate nullable read-only

string

date-time

The date the item was approved.

clientCropData required nullable read-only

crop-data

Customer selected crop data, overwrites default crop if provided.

clientNotes read-only

string

Notes provided by the customer when they added the item to the order.

created nullable read-only

string

date-time

The date on which this item was added to the order.

cropData required nullable

crop-data

Default Crop

Defaults to center crop, overwritten by clientCropData if present.

Property	Description
maxX	`number` float ≥ 0 ≤ 100 Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
maxY	`number` float ≥ 0 ≤ 100 Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
minX	`number` float ≥ 0 ≤ 100 Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
minY	`number` float ≥ 0 ≤ 100 Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
type	`string` enum crop-data The type of object represented.

digitalDownloadPixels read-only

integer

Max pixel dimension of the digital download.

digitalDownloadTypeId read-only

integer

Ref ID noting the digital download type.

eventAlbumId

integer

The ID of the album containing the photo(s) making up this order item.

filterType

string

enum

none
black-and-white
sepia

Filter applied to the photo for creation of this item.

fulfillmentType read-only

string

enum

lab
digital
self

Slugs description of the order item fulfillment type.

groupId read-only

string

^[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}$

The UUID of the price sheet categorization group to which this item belongs.

groupName read-only

string

The name of the price sheet categorization group to which this item belongs.

id read-only

string

^[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}$

The identifier for this order item, a UUID.

isAlbumFiles read-only

boolean

Flags whether the object is comprised of all photo files in the album.

isAllFiles read-only

boolean

Flags whether the object is comprised of all photo files in the event.

isLowPhotoDpi nullable read-only

boolean

Flag to indicate whether the photo DPI is beneath the threshold for low DPI (100). null if the DPI cannot be determined.

labCatalogProductId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

labProductRetailPrice read-only

number

The retail price of this item in the lab catalog.

name

string

The human readable item name. Should be derived from the names of the item group and add on group names.

origin

string

enum

studio
client

default "client"

Indicates the origin of the item in the order. Default is client indicating a client/customer added the item to the order. studio indicates that the item was added to the order by the studio.

originalPrice read-only

number

Pre-discount retail price of the item.

photo read-only

either

order-photo

event-photo

The item's photo. May return an order-photo or an event-photo resource.

photoDpi nullable read-only

number

The photo DPI for this item, function of photo's pixel dimensions and item size. null if the DPI cannot be determined.

photoId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

price read-only

number

The item price. This value is calculated as the sum of each item add-on's price.

quantity

integer

Number of instances of this item appearing in the order.

size read-only

string

The item size, expressed in terms of x1, y1, x2, y2 (top left, bottom right, in inches).

status read-only

string

enum

active
deleted

The item status.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

Property	Description
currentPage	`integer` The current page of results returned.
rows	`integer` The number of rows returned per page for the current result set.
totalItems	`integer` The total number of items in the result set. This may be affected by active search/filter parameters.
totalPages	`integer` The total number of pages in the result set. This is affected by the `rows` parameter (`totalItems / rows == totalPages`).

type

string

enum

order-item-collection

Type

The model type for the list response object.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/OrderItemCollection"
        }
      }
    },
    "description": "Order item list response."
  }
}

Beta Creates a new order item for the current order.

Creates a new order item for each photoId present in the request, responding with the newly created order item.

post

/studio/brand/{brandId}/order/{orderId}/item

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The order item object to create.

application/vnd.shootproof+json

Property Description

altDisplayName

string

The (optional) alternate display name for this item.

cropData required nullable

crop-data

Default Crop

Defaults to center crop, overwritten by clientCropData if present.

Property	Description
maxX	`number` float ≥ 0 ≤ 100 Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
maxY	`number` float ≥ 0 ≤ 100 Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
minX	`number` float ≥ 0 ≤ 100 Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
minY	`number` float ≥ 0 ≤ 100 Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
type	`string` enum crop-data The type of object represented.

eventAlbumId

integer

The ID of the album containing the photo(s) making up this order item.

filterType

string

enum

none
black-and-white
sepia

Filter applied to the photo for creation of this item.

labCatalogProductId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

name

string

The human readable item name. Should be derived from the names of the item group and add on group names.

origin

string

enum

studio
client

default "client"

Indicates the origin of the item in the order. Default is client indicating a client/customer added the item to the order. studio indicates that the item was added to the order by the studio.

photoId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

quantity

integer

Number of instances of this item appearing in the order.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/OrderItem"
      }
    }
  },
  "description": "The order item object to create.",
  "required": true
}

Receiving the response

`200 OK`

The order that owns the successfully-created order item(s).

Headers

Header	Description
Content-Location	`string` uri The canonical URL of the order that the newly created items belong to.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

albumPath read-only

string

The string path through the album hierarchy to the album containing the photo this item is based on. Captured at order creation time.

altDisplayName

string

The (optional) alternate display name for this item.

approved read-only

boolean

Flag indicating whether this item has been marked as approved within the context of this order. Items are individually approved in the order.

approvedDate nullable read-only

string

date-time

The date the item was approved.

clientCropData required nullable read-only

crop-data

Customer selected crop data, overwrites default crop if provided.

clientNotes read-only

string

Notes provided by the customer when they added the item to the order.

created nullable read-only

string

date-time

The date on which this item was added to the order.

cropData required nullable

crop-data

Default Crop

Defaults to center crop, overwritten by clientCropData if present.

Property	Description
maxX	`number` float ≥ 0 ≤ 100 Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
maxY	`number` float ≥ 0 ≤ 100 Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
minX	`number` float ≥ 0 ≤ 100 Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
minY	`number` float ≥ 0 ≤ 100 Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
type	`string` enum crop-data The type of object represented.

digitalDownloadPixels read-only

integer

Max pixel dimension of the digital download.

digitalDownloadTypeId read-only

integer

Ref ID noting the digital download type.

eventAlbumId

integer

The ID of the album containing the photo(s) making up this order item.

filterType

string

enum

none
black-and-white
sepia

Filter applied to the photo for creation of this item.

fulfillmentType read-only

string

enum

lab
digital
self

Slugs description of the order item fulfillment type.

groupId read-only

string

^[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}$

The UUID of the price sheet categorization group to which this item belongs.

groupName read-only

string

The name of the price sheet categorization group to which this item belongs.

id read-only

string

^[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}$

The identifier for this order item, a UUID.

isAlbumFiles read-only

boolean

Flags whether the object is comprised of all photo files in the album.

isAllFiles read-only

boolean

Flags whether the object is comprised of all photo files in the event.

isLowPhotoDpi nullable read-only

boolean

Flag to indicate whether the photo DPI is beneath the threshold for low DPI (100). null if the DPI cannot be determined.

labCatalogProductId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

labProductRetailPrice read-only

number

The retail price of this item in the lab catalog.

name

string

The human readable item name. Should be derived from the names of the item group and add on group names.

origin

string

enum

studio
client

default "client"

Indicates the origin of the item in the order. Default is client indicating a client/customer added the item to the order. studio indicates that the item was added to the order by the studio.

originalPrice read-only

number

Pre-discount retail price of the item.

photo read-only

either

order-photo

event-photo

The item's photo. May return an order-photo or an event-photo resource.

photoDpi nullable read-only

number

The photo DPI for this item, function of photo's pixel dimensions and item size. null if the DPI cannot be determined.

photoId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

price read-only

number

The item price. This value is calculated as the sum of each item add-on's price.

quantity

integer

Number of instances of this item appearing in the order.

size read-only

string

The item size, expressed in terms of x1, y1, x2, y2 (top left, bottom right, in inches).

status read-only

string

enum

active
deleted

The item status.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/OrderItem"
        }
      }
    },
    "description": "The order that owns the successfully-created order item(s).",
    "headers": {
      "Content-Location": {
        "description": "The canonical URL of the order that the newly created items belong to.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Beta Removes an order item.

delete

/studio/brand/{brandId}/order/{orderId}/item/{orderItemId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.
orderItemId required	`integer` The order item identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

204
Schema

`204 No Content`

Successful deletion response.

OpenAPI Schema

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

{
  "204": {
    "description": "Successful deletion response."
  }
}

Beta Lists an order item identified by it id

Returns a single order item by its ID

get

/studio/brand/{brandId}/order/{orderId}/item/{orderItemId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.
orderItemId required	`integer` The order item identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

200
Schema

`200 OK`

Order item response.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

albumPath read-only

string

The string path through the album hierarchy to the album containing the photo this item is based on. Captured at order creation time.

altDisplayName

string

The (optional) alternate display name for this item.

approved read-only

boolean

Flag indicating whether this item has been marked as approved within the context of this order. Items are individually approved in the order.

approvedDate nullable read-only

string

date-time

The date the item was approved.

clientCropData required nullable read-only

crop-data

Customer selected crop data, overwrites default crop if provided.

clientNotes read-only

string

Notes provided by the customer when they added the item to the order.

created nullable read-only

string

date-time

The date on which this item was added to the order.

cropData required nullable

crop-data

Default Crop

Defaults to center crop, overwritten by clientCropData if present.

Property	Description
maxX	`number` float ≥ 0 ≤ 100 Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
maxY	`number` float ≥ 0 ≤ 100 Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
minX	`number` float ≥ 0 ≤ 100 Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
minY	`number` float ≥ 0 ≤ 100 Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
type	`string` enum crop-data The type of object represented.

digitalDownloadPixels read-only

integer

Max pixel dimension of the digital download.

digitalDownloadTypeId read-only

integer

Ref ID noting the digital download type.

eventAlbumId

integer

The ID of the album containing the photo(s) making up this order item.

filterType

string

enum

none
black-and-white
sepia

Filter applied to the photo for creation of this item.

fulfillmentType read-only

string

enum

lab
digital
self

Slugs description of the order item fulfillment type.

groupId read-only

string

^[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}$

The UUID of the price sheet categorization group to which this item belongs.

groupName read-only

string

The name of the price sheet categorization group to which this item belongs.

id read-only

string

^[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}$

The identifier for this order item, a UUID.

isAlbumFiles read-only

boolean

Flags whether the object is comprised of all photo files in the album.

isAllFiles read-only

boolean

Flags whether the object is comprised of all photo files in the event.

isLowPhotoDpi nullable read-only

boolean

Flag to indicate whether the photo DPI is beneath the threshold for low DPI (100). null if the DPI cannot be determined.

labCatalogProductId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

labProductRetailPrice read-only

number

The retail price of this item in the lab catalog.

name

string

The human readable item name. Should be derived from the names of the item group and add on group names.

origin

string

enum

studio
client

default "client"

Indicates the origin of the item in the order. Default is client indicating a client/customer added the item to the order. studio indicates that the item was added to the order by the studio.

originalPrice read-only

number

Pre-discount retail price of the item.

photo read-only

either

order-photo

event-photo

The item's photo. May return an order-photo or an event-photo resource.

photoDpi nullable read-only

number

The photo DPI for this item, function of photo's pixel dimensions and item size. null if the DPI cannot be determined.

photoId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

price read-only

number

The item price. This value is calculated as the sum of each item add-on's price.

quantity

integer

Number of instances of this item appearing in the order.

size read-only

string

The item size, expressed in terms of x1, y1, x2, y2 (top left, bottom right, in inches).

status read-only

string

enum

active
deleted

The item status.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/OrderItem"
        }
      }
    },
    "description": "Order item response."
  }
}

Beta Partially updates an order item.

patch

/studio/brand/{brandId}/order/{orderId}/item/{orderItemId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.
orderItemId required	`integer` The order item identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The order item object to update. Only provide those properties that need updating.

application/vnd.shootproof+json

Property Description

altDisplayName

string

The (optional) alternate display name for this item.

cropData required nullable

crop-data

Default Crop

Defaults to center crop, overwritten by clientCropData if present.

Property	Description
maxX	`number` float ≥ 0 ≤ 100 Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
maxY	`number` float ≥ 0 ≤ 100 Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
minX	`number` float ≥ 0 ≤ 100 Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
minY	`number` float ≥ 0 ≤ 100 Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
type	`string` enum crop-data The type of object represented.

eventAlbumId

integer

The ID of the album containing the photo(s) making up this order item.

filterType

string

enum

none
black-and-white
sepia

Filter applied to the photo for creation of this item.

labCatalogProductId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

name

string

The human readable item name. Should be derived from the names of the item group and add on group names.

origin

string

enum

studio
client

default "client"

Indicates the origin of the item in the order. Default is client indicating a client/customer added the item to the order. studio indicates that the item was added to the order by the studio.

photoId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

quantity

integer

Number of instances of this item appearing in the order.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/OrderItem"
      }
    }
  },
  "description": "The order item object to update. Only provide those properties that\nneed updating.",
  "required": true
}

Receiving the response

`200 OK`

The successfully-updated order item.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

albumPath read-only

string

The string path through the album hierarchy to the album containing the photo this item is based on. Captured at order creation time.

altDisplayName

string

The (optional) alternate display name for this item.

approved read-only

boolean

Flag indicating whether this item has been marked as approved within the context of this order. Items are individually approved in the order.

approvedDate nullable read-only

string

date-time

The date the item was approved.

clientCropData required nullable read-only

crop-data

Customer selected crop data, overwrites default crop if provided.

clientNotes read-only

string

Notes provided by the customer when they added the item to the order.

created nullable read-only

string

date-time

The date on which this item was added to the order.

cropData required nullable

crop-data

Default Crop

Defaults to center crop, overwritten by clientCropData if present.

Property	Description
maxX	`number` float ≥ 0 ≤ 100 Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
maxY	`number` float ≥ 0 ≤ 100 Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
minX	`number` float ≥ 0 ≤ 100 Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
minY	`number` float ≥ 0 ≤ 100 Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
type	`string` enum crop-data The type of object represented.

digitalDownloadPixels read-only

integer

Max pixel dimension of the digital download.

digitalDownloadTypeId read-only

integer

Ref ID noting the digital download type.

eventAlbumId

integer

The ID of the album containing the photo(s) making up this order item.

filterType

string

enum

none
black-and-white
sepia

Filter applied to the photo for creation of this item.

fulfillmentType read-only

string

enum

lab
digital
self

Slugs description of the order item fulfillment type.

groupId read-only

string

^[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}$

The UUID of the price sheet categorization group to which this item belongs.

groupName read-only

string

The name of the price sheet categorization group to which this item belongs.

id read-only

string

^[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}$

The identifier for this order item, a UUID.

isAlbumFiles read-only

boolean

Flags whether the object is comprised of all photo files in the album.

isAllFiles read-only

boolean

Flags whether the object is comprised of all photo files in the event.

isLowPhotoDpi nullable read-only

boolean

Flag to indicate whether the photo DPI is beneath the threshold for low DPI (100). null if the DPI cannot be determined.

labCatalogProductId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

labProductRetailPrice read-only

number

The retail price of this item in the lab catalog.

name

string

The human readable item name. Should be derived from the names of the item group and add on group names.

origin

string

enum

studio
client

default "client"

Indicates the origin of the item in the order. Default is client indicating a client/customer added the item to the order. studio indicates that the item was added to the order by the studio.

originalPrice read-only

number

Pre-discount retail price of the item.

photo read-only

either

order-photo

event-photo

The item's photo. May return an order-photo or an event-photo resource.

photoDpi nullable read-only

number

The photo DPI for this item, function of photo's pixel dimensions and item size. null if the DPI cannot be determined.

photoId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

price read-only

number

The item price. This value is calculated as the sum of each item add-on's price.

quantity

integer

Number of instances of this item appearing in the order.

size read-only

string

The item size, expressed in terms of x1, y1, x2, y2 (top left, bottom right, in inches).

status read-only

string

enum

active
deleted

The item status.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/OrderItem"
        }
      }
    },
    "description": "The successfully-updated order item."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Beta Fully updates an order item.

put

/studio/brand/{brandId}/order/{orderId}/item/{orderItemId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.
orderItemId required	`integer` The order item identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The order item object to update.

application/vnd.shootproof+json

Property Description

altDisplayName

string

The (optional) alternate display name for this item.

cropData required nullable

crop-data

Default Crop

Defaults to center crop, overwritten by clientCropData if present.

Property	Description
maxX	`number` float ≥ 0 ≤ 100 Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
maxY	`number` float ≥ 0 ≤ 100 Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
minX	`number` float ≥ 0 ≤ 100 Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
minY	`number` float ≥ 0 ≤ 100 Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
type	`string` enum crop-data The type of object represented.

eventAlbumId

integer

The ID of the album containing the photo(s) making up this order item.

filterType

string

enum

none
black-and-white
sepia

Filter applied to the photo for creation of this item.

labCatalogProductId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

name

string

The human readable item name. Should be derived from the names of the item group and add on group names.

origin

string

enum

studio
client

default "client"

Indicates the origin of the item in the order. Default is client indicating a client/customer added the item to the order. studio indicates that the item was added to the order by the studio.

photoId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

quantity

integer

Number of instances of this item appearing in the order.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/OrderItem"
      }
    }
  },
  "description": "The order item object to update.",
  "required": true
}

Receiving the response

`200 OK`

The successfully-updated order item.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

albumPath read-only

string

The string path through the album hierarchy to the album containing the photo this item is based on. Captured at order creation time.

altDisplayName

string

The (optional) alternate display name for this item.

approved read-only

boolean

Flag indicating whether this item has been marked as approved within the context of this order. Items are individually approved in the order.

approvedDate nullable read-only

string

date-time

The date the item was approved.

clientCropData required nullable read-only

crop-data

Customer selected crop data, overwrites default crop if provided.

clientNotes read-only

string

Notes provided by the customer when they added the item to the order.

created nullable read-only

string

date-time

The date on which this item was added to the order.

cropData required nullable

crop-data

Default Crop

Defaults to center crop, overwritten by clientCropData if present.

Property	Description
maxX	`number` float ≥ 0 ≤ 100 Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
maxY	`number` float ≥ 0 ≤ 100 Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
minX	`number` float ≥ 0 ≤ 100 Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.
minY	`number` float ≥ 0 ≤ 100 Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.
type	`string` enum crop-data The type of object represented.

digitalDownloadPixels read-only

integer

Max pixel dimension of the digital download.

digitalDownloadTypeId read-only

integer

Ref ID noting the digital download type.

eventAlbumId

integer

The ID of the album containing the photo(s) making up this order item.

filterType

string

enum

none
black-and-white
sepia

Filter applied to the photo for creation of this item.

fulfillmentType read-only

string

enum

lab
digital
self

Slugs description of the order item fulfillment type.

groupId read-only

string

^[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}$

The UUID of the price sheet categorization group to which this item belongs.

groupName read-only

string

The name of the price sheet categorization group to which this item belongs.

id read-only

string

^[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}$

The identifier for this order item, a UUID.

isAlbumFiles read-only

boolean

Flags whether the object is comprised of all photo files in the album.

isAllFiles read-only

boolean

Flags whether the object is comprised of all photo files in the event.

isLowPhotoDpi nullable read-only

boolean

Flag to indicate whether the photo DPI is beneath the threshold for low DPI (100). null if the DPI cannot be determined.

labCatalogProductId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

labProductRetailPrice read-only

number

The retail price of this item in the lab catalog.

name

string

The human readable item name. Should be derived from the names of the item group and add on group names.

origin

string

enum

studio
client

default "client"

Indicates the origin of the item in the order. Default is client indicating a client/customer added the item to the order. studio indicates that the item was added to the order by the studio.

originalPrice read-only

number

Pre-discount retail price of the item.

photo read-only

either

order-photo

event-photo

The item's photo. May return an order-photo or an event-photo resource.

photoDpi nullable read-only

number

The photo DPI for this item, function of photo's pixel dimensions and item size. null if the DPI cannot be determined.

photoId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

price read-only

number

The item price. This value is calculated as the sum of each item add-on's price.

quantity

integer

Number of instances of this item appearing in the order.

size read-only

string

The item size, expressed in terms of x1, y1, x2, y2 (top left, bottom right, in inches).

status read-only

string

enum

active
deleted

The item status.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/OrderItem"
        }
      }
    },
    "description": "The successfully-updated order item."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Beta Returns a list of client payments for an order.

Returns a list of client payments for an order.

get

/studio/brand/{brandId}/order/{orderId}/payment

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
orderId required	`integer` The order identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

200
Schema

`200 OK`

Order payment list response.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

items

order-payment[]

Order Client Payment

A collection of resources returned in the current result set.

Property	Description
amount	`number` The amount of this payment.
billingPostalCode	`string` ^[A-Za-z0-9 -]{0,10}$ The billing address postal code. May be `null` for order payments made prior to the introduction of this value.
checkNumber nullable	`integer` If this payment was made by check, the check number for the payment.
created read-only	`string` date-time The date on which this payment was logged in the system.
currencyCode read-only	`string` Identifies the currency in which this payment was made. This is always the currency of the order; it cannot be set when making a payment.
currencySymbol read-only	`string` The currency symbol for the currency used for this payment.
emailAddress	`string` email The email address for the person making the payment.
id	`integer` The identifier for this order payment.
isPaymentOnHold nullable read-only	`boolean` If `paymentFundsType` is "credit-card" and payment was made with ShootProof Payments, this flag indicates whether the funds for this payment are currently on hold. This is typically the case during a five-day period after credit payment was made, but before ShootProof releases the profit to the Studio. If `false`, the payment has been released. If `null`, releasing of funds is not applicable such as when made with cash/check, or a non-ShootProof Payments gateway, such as Authorize.Net, Braintree, or PayPal Pro. If either `isPaymentOnHold` or `isPaymentReleased` are non-null, only one of them will be `true` at any point a time.
isPaymentReleased nullable read-only	`boolean` If `paymentFundsType` is "credit-card" and payment was made with ShootProof Payments, this flag indicates whether the funds from this payment have been released. If `false`, the payment is still on hold. If `null`, releasing of funds is not applicable such as when made with cash/check, or a non-ShootProof Payments gateway, such as Authorize.Net, Braintree, or PayPal Pro. If either `isPaymentOnHold` or `isPaymentReleased` are non-null, only one of them will be `true` at any point a time.
isRefundable read-only	`boolean` Whether the payment is able to be refunded.
nameOnCard	`string` The card-holder name.
note nullable	`string` A note about the payment.
paymentDate	`string` date-time The date on which this payment was made.
paymentFundsType	`string` enum cash check credit-card invoice The type of funds received for this payment.
paymentReleasedDate nullable read-only	`string` date-time If `isPaymentReleased` is `true`, this indicates the date on which the payment was released.
type	`string` enum order-payment The type of object represented.

links required read-only

object