Contents

Orders

A major part of a brand’s business is handling orders. Together with invoices, orders are how ShootProof helps photography studios grow sustainable businesses. Through the ShootProof API, your app can provide tools to help photographers manage and fulfill orders.

Lists all orders for the current brand.

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

get
/studio/brand/{brandId}/order

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

Query Parameters

Property Description
filterCombinedOrder

If provided and truthy, returns orders that are a combined order.

filterDigitalStatus

The digital status ID by which to filter results.

filterEventId

The event ID by which to filter results.

filterFulfillmentType

The order fulfillment type by which to filter results.

filterHasCustomerCrop

If provided and truthy, returns orders with customer submitted crop data.

filterHasCustomerNotes

If provided and truthy, returns orders with customer submitted notes.

filterHasRetouchRequest

If provided and truthy, returns orders with a request for retouching.

filterLabStatus

The lab status ID by which to filter results.

filterOrderId

The order ID by which to filter results.

filterOrderOrigin

Filter results by either customer or studio placed orders.

filterOrderStatus

The order status ID by which to filter results.

filterParentOrderId

The parent order ID by which to filter results.

filterPaymentStatus

The order payment status by which to filter results.

page

The page of results to return.

rows

The number of rows to return on each page of results.

searchCustomerEmail

The customer email address by which to filter results.

searchCustomerName

The customer name by which to filter results.

sortBy

The property by which items returned should be sorted.

sortType

The direction in which sorting should occur.

Header Parameters

Property Description
Authentication required

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.

200 OK

Orders 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

A collection of resources returned in the current result set.

Property Description
combinedOrder

Indicates whether this order was created by combining multiple orders.

created

The creation date of this order.

currencyCode

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

currencySymbol

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

customStatus nullable

The human readable name of the current custom status of this order. Custom statuses are defined by the user in their brand preferences. Available statuses for an order will be one of either orderStatus or orderCustomStatus. If orderStatus is null, orderCustomStatus will have a value and vice versa.

customerCropSelected

Whether this order contains items having a customer defined crop.

customerEmail

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

customerName

The name of the customer having billing responsibility for this order.

customerSubmittedNotes

Whether this order contains customer submitted notes.

digitalStatus nullable

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

The identifier for the event this order originates from. This can only be null if the order is part of a combined order.

eventName

The name of the event this order originates from.

fulfillmentTypes

Human readable description of the order fulfillment type. This can be derived from the labStatusId/labStatus fields, but is provided here as a convenience.

grandTotal

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.

id

The identifier for this order, a UUID.

labId nullable

The identifier for the lab fulfilling any lab fulfilled items in this order. Null if there are no lab fulfilled items in the order.

labName nullable read-only

The name of the lab fulfilling this order. Orders can have only one lab, as all lab-fulfilled items in an order will be fulfilled by the same lab.

labStatus nullable

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.

links required read-only

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

The slug string name of the current status of this order. See orderCustomStatus for description of interaction with that field.

origin

Describes whether the order was placed by the customer or by the studio.

paymentStatus

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'.

type

The type of object represented.

links required read-only

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.

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

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."
  }
}

Creates a new order for the current brand.

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

post
/studio/brand/{brandId}/order

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

Header Parameters

Property Description
Authentication required

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

The billing address for this order.

clientNote

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

clientSelectedShippingId

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

customerEmail

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

customerPhone nullable

The phone number submitted with the order. Any non-numeric characters will be stripped.

eventId nullable

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.

items

The items belonging to the order.

labCatalogId

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

orderStatus nullable

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

pickupAtStudio

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

The address this order should be shipped to.

shippingCharge

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

studioNote

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

tags

Tags describing this order.

type

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
}

201 Created

The successfully-created order.

Headers
Header Description
Location

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 read-only

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

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

The billing address for this order.

clientNote

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

clientSelectedShippingId

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

combinedOrder read-only

Indicates whether this order was created by combining multiple orders.

created read-only

The creation date of this order.

currencyCode read-only

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

currencySymbol read-only

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

customerCropSelected read-only

Whether this order contains items having a customer defined crop.

customerEmail

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

customerName read-only

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

The phone number submitted with the order. Any non-numeric characters will be stripped.

digitalDownloadDate read-only

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

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 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

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

The name of the event this order originates from.

fulfillmentTypes read-only

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

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.

id read-only

The identifier for this order, a UUID?.

items

The items belonging to the order.

labApprovedByStudioDate read-only

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

labCatalogId

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

labName nullable read-only

The name of the lab fulfilling this order. Orders can have only one lab, as all lab-fulfilled items in an order will be fulfilled by the same lab.

labReceipts read-only

Collection of records of lab receipts of orders.

Property Description
id read-only

The record identifier for the receipt.

labOrderNumber read-only

The order number created by the lab for processing this SP order.

receiptDate read-only

The date when this order was accepted by the lab, the receipt date.

labShipments read-only

Lab shipments associated with this order

Property Description
created read-only

The creation date of this shipment record.

id read-only

The record identifier for the shipment.

labOrderNumber read-only

The order number created by the lab for processing this SP order.

labReference read-only

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

The date when this shipment was reported as shipped.

trackingId read-only

The shipment tracking ID, used for tracking the shipment.

trackingUrl read-only

The shipment tracking URL, used for tracking the shipment.

labStatus nullable read-only

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 read-only

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

links required read-only

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

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

origin read-only

Describes whether the order was placed by the customer or by the studio.

paymentStatus read-only

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

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 read-only

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

profitReleased read-only

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.

roesOrderId nullable read-only

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

salesTax read-only

Amount of sales tax applied to this order.

salesTaxOnDigitals read-only

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

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

The percentage used to calculate sales tax amount.

salesTaxStateId read-only

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

salesTaxTitle read-only

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

The address this order should be shipped to.

shippingCharge

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

studioNote

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

tags

Tags describing this order.

type

The model type for the response object.

vatNumber nullable read-only

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

vatTotal read-only

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

A longer description of of the error encountered.

info

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

Property Description
errors

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

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

The HTTP status code associated with this error.

title

A short description of the error encountered.

type

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"
  }
}

Removes an order.

Changes order status to deleted.

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

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

Header Parameters

Property Description
Authentication required

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.

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."
  }
}

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}

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

Header Parameters

Property Description
Authentication required

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.

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 read-only

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

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

The billing address for this order.

clientNote

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

clientSelectedShippingId

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

combinedOrder read-only

Indicates whether this order was created by combining multiple orders.

created read-only

The creation date of this order.

currencyCode read-only

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

currencySymbol read-only

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

customerCropSelected read-only

Whether this order contains items having a customer defined crop.

customerEmail

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

customerName read-only

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

The phone number submitted with the order. Any non-numeric characters will be stripped.

digitalDownloadDate read-only

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

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 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

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

The name of the event this order originates from.

fulfillmentTypes read-only

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

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.

id read-only

The identifier for this order, a UUID?.

items

The items belonging to the order.

labApprovedByStudioDate read-only

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

labCatalogId

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

labName nullable read-only

The name of the lab fulfilling this order. Orders can have only one lab, as all lab-fulfilled items in an order will be fulfilled by the same lab.

labReceipts read-only

Collection of records of lab receipts of orders.

Property Description
id read-only

The record identifier for the receipt.

labOrderNumber read-only

The order number created by the lab for processing this SP order.

receiptDate read-only

The date when this order was accepted by the lab, the receipt date.

labShipments read-only

Lab shipments associated with this order

Property Description
created read-only

The creation date of this shipment record.

id read-only

The record identifier for the shipment.

labOrderNumber read-only

The order number created by the lab for processing this SP order.

labReference read-only

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

The date when this shipment was reported as shipped.

trackingId read-only

The shipment tracking ID, used for tracking the shipment.

trackingUrl read-only

The shipment tracking URL, used for tracking the shipment.

labStatus nullable read-only

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 read-only

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

links required read-only

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

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

origin read-only

Describes whether the order was placed by the customer or by the studio.

paymentStatus read-only

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

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 read-only

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

profitReleased read-only

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.

roesOrderId nullable read-only

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

salesTax read-only

Amount of sales tax applied to this order.

salesTaxOnDigitals read-only

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

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

The percentage used to calculate sales tax amount.

salesTaxStateId read-only

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

salesTaxTitle read-only

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

The address this order should be shipped to.

shippingCharge

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

studioNote

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

tags

Tags describing this order.

type

The model type for the response object.

vatNumber nullable read-only

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

vatTotal read-only

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

A longer description of of the error encountered.

info

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

Property Description
reason

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

The HTTP status code associated with this error.

title

A short description of the error encountered.

type

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"
  }
}

Partially updates an order.

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

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

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

Header Parameters

Property Description
Authentication required

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

The billing address for this order.

clientNote

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

customerEmail

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

customerPhone nullable

The phone number submitted with the order. Any non-numeric characters will be stripped.

items

The items belonging to the order.

notes

Order notes.

Property Description
clientNote read-only

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

studioNote

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

orderStatus nullable

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

pickupAtStudio

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

The address this order should be shipped to.

shippingCharge

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

studioNote

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

tags

Tags describing this order.

type

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
}

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 read-only

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

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

The billing address for this order.

clientNote

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

clientSelectedShippingId

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

combinedOrder read-only

Indicates whether this order was created by combining multiple orders.

created read-only

The creation date of this order.

currencyCode read-only

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

currencySymbol read-only

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

customerCropSelected read-only

Whether this order contains items having a customer defined crop.

customerEmail

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

customerName read-only

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

The phone number submitted with the order. Any non-numeric characters will be stripped.

digitalDownloadDate read-only

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

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 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

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

The name of the event this order originates from.

fulfillmentTypes read-only

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

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.

id read-only

The identifier for this order, a UUID?.

items

The items belonging to the order.

labApprovedByStudioDate read-only

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

labCatalogId

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

labName nullable read-only

The name of the lab fulfilling this order. Orders can have only one lab, as all lab-fulfilled items in an order will be fulfilled by the same lab.

labReceipts read-only

Collection of records of lab receipts of orders.

Property Description
id read-only

The record identifier for the receipt.

labOrderNumber read-only

The order number created by the lab for processing this SP order.

receiptDate read-only

The date when this order was accepted by the lab, the receipt date.

labShipments read-only

Lab shipments associated with this order

Property Description
created read-only

The creation date of this shipment record.

id read-only

The record identifier for the shipment.

labOrderNumber read-only

The order number created by the lab for processing this SP order.

labReference read-only

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

The date when this shipment was reported as shipped.

trackingId read-only

The shipment tracking ID, used for tracking the shipment.

trackingUrl read-only

The shipment tracking URL, used for tracking the shipment.

labStatus nullable read-only

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 read-only

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

links required read-only

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

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

origin read-only

Describes whether the order was placed by the customer or by the studio.

paymentStatus read-only

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

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 read-only

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

profitReleased read-only

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.

roesOrderId nullable read-only

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

salesTax read-only

Amount of sales tax applied to this order.

salesTaxOnDigitals read-only

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

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

The percentage used to calculate sales tax amount.

salesTaxStateId read-only

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

salesTaxTitle read-only

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

The address this order should be shipped to.

shippingCharge

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

studioNote

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

tags

Tags describing this order.

type

The model type for the response object.

vatNumber nullable read-only

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

vatTotal read-only

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

A longer description of of the error encountered.

info

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

Property Description
errors

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

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

The HTTP status code associated with this error.

title

A short description of the error encountered.

type

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"
  }
}

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

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

Header Parameters

Property Description
Authentication required

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

The message to include in the body of the email.

recipientEmails

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

The subject line for the email message.

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
}

202 Accepted

Responds with the order on success.

Headers
Header Description
Content-Location

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 read-only

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

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

The billing address for this order.

clientNote

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

clientSelectedShippingId

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

combinedOrder read-only

Indicates whether this order was created by combining multiple orders.

created read-only

The creation date of this order.

currencyCode read-only

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

currencySymbol read-only

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

customerCropSelected read-only

Whether this order contains items having a customer defined crop.

customerEmail

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

customerName read-only

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

The phone number submitted with the order. Any non-numeric characters will be stripped.

digitalDownloadDate read-only

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

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 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

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

The name of the event this order originates from.

fulfillmentTypes read-only

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

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.

id read-only

The identifier for this order, a UUID?.

items

The items belonging to the order.

labApprovedByStudioDate read-only

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

labCatalogId

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

labName nullable read-only

The name of the lab fulfilling this order. Orders can have only one lab, as all lab-fulfilled items in an order will be fulfilled by the same lab.

labReceipts read-only

Collection of records of lab receipts of orders.

Property Description
id read-only

The record identifier for the receipt.

labOrderNumber read-only

The order number created by the lab for processing this SP order.

receiptDate read-only

The date when this order was accepted by the lab, the receipt date.

labShipments read-only

Lab shipments associated with this order

Property Description
created read-only

The creation date of this shipment record.

id read-only

The record identifier for the shipment.

labOrderNumber read-only

The order number created by the lab for processing this SP order.

labReference read-only

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

The date when this shipment was reported as shipped.

trackingId read-only

The shipment tracking ID, used for tracking the shipment.

trackingUrl read-only

The shipment tracking URL, used for tracking the shipment.

labStatus nullable read-only

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 read-only

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

links required read-only

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

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

origin read-only

Describes whether the order was placed by the customer or by the studio.

paymentStatus read-only

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

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 read-only

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

profitReleased read-only

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.

roesOrderId nullable read-only

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

salesTax read-only

Amount of sales tax applied to this order.

salesTaxOnDigitals read-only

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

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

The percentage used to calculate sales tax amount.

salesTaxStateId read-only

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

salesTaxTitle read-only

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

The address this order should be shipped to.

shippingCharge

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

studioNote

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

tags

Tags describing this order.

type

The model type for the response object.

vatNumber nullable read-only

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

vatTotal read-only

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

A longer description of of the error encountered.

info

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

Property Description
errors

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

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

The HTTP status code associated with this error.

title

A short description of the error encountered.

type

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"
  }
}

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

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

Header Parameters

Property Description
Authentication required

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.

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

A collection of resources returned in the current result set.

Property Description
albumPath read-only

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

altDisplayName

The (optional) alternate display name for this item.

approved read-only

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

approvedDate nullable read-only

The date the item was approved.

clientCropData required nullable read-only

Customer selected crop data, overwrites default crop if provided.

clientNotes read-only

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

created nullable read-only

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

cropData required nullable

Defaults to center crop, overwritten by clientCropData if present.

Property Description
maxX

Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

maxY

Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

minX

Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

minY

Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

type

The type of object represented.

digitalDownloadPixels read-only

Max pixel dimension of the digital download.

digitalDownloadTypeId read-only

Ref ID noting the digital download type.

eventAlbumId

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

filterType

Filter applied to the photo for creation of this item.

fulfillmentType read-only

Slugs description of the order item fulfillment type.

groupId read-only

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

groupName read-only

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

id read-only

The identifier for this order item, a UUID.

isAlbumFiles read-only

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

isAllFiles read-only

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

isLowPhotoDpi nullable read-only

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

labCatalogProductId

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

labProductRetailPrice read-only

The retail price of this item in the lab catalog.

name

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

origin

Indicates the origin of the item in the order. Default is 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

Pre-discount retail price of the item.

photo read-only

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

photoDpi nullable read-only

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

photoId

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

price read-only

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

quantity

Number of instances of this item appearing in the order.

size read-only

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

status read-only

The item status.

links required read-only

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.

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

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."
  }
}

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

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

Header Parameters

Property Description
Authentication required

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

The (optional) alternate display name for this item.

cropData required nullable

Defaults to center crop, overwritten by clientCropData if present.

Property Description
maxX

Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

maxY

Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

minX

Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

minY

Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

type

The type of object represented.

eventAlbumId

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

filterType

Filter applied to the photo for creation of this item.

labCatalogProductId

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

name

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

origin

Indicates the origin of the item in the order. Default is 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

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

quantity

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
}

200 OK

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

Headers
Header Description
Content-Location

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

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

altDisplayName

The (optional) alternate display name for this item.

approved read-only

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

approvedDate nullable read-only

The date the item was approved.

clientCropData required nullable read-only

Customer selected crop data, overwrites default crop if provided.

clientNotes read-only

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

created nullable read-only

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

cropData required nullable

Defaults to center crop, overwritten by clientCropData if present.

Property Description
maxX

Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

maxY

Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

minX

Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

minY

Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

type

The type of object represented.

digitalDownloadPixels read-only

Max pixel dimension of the digital download.

digitalDownloadTypeId read-only

Ref ID noting the digital download type.

eventAlbumId

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

filterType

Filter applied to the photo for creation of this item.

fulfillmentType read-only

Slugs description of the order item fulfillment type.

groupId read-only

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

groupName read-only

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

id read-only

The identifier for this order item, a UUID.

isAlbumFiles read-only

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

isAllFiles read-only

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

isLowPhotoDpi nullable read-only

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

labCatalogProductId

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

labProductRetailPrice read-only

The retail price of this item in the lab catalog.

name

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

origin

Indicates the origin of the item in the order. Default is 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

Pre-discount retail price of the item.

photo read-only

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

photoDpi nullable read-only

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

photoId

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

price read-only

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

quantity

Number of instances of this item appearing in the order.

size read-only

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

status read-only

The item status.

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

A longer description of of the error encountered.

info

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

Property Description
errors

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

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

The HTTP status code associated with this error.

title

A short description of the error encountered.

type

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"
  }
}

Removes an order item.

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

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

orderItemId required

The order item identifier.

Header Parameters

Property Description
Authentication required

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.

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."
  }
}

Lists an order item identified by it id

Returns a single order item by its ID

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

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

orderItemId required

The order item identifier.

Header Parameters

Property Description
Authentication required

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.

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

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

altDisplayName

The (optional) alternate display name for this item.

approved read-only

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

approvedDate nullable read-only

The date the item was approved.

clientCropData required nullable read-only

Customer selected crop data, overwrites default crop if provided.

clientNotes read-only

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

created nullable read-only

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

cropData required nullable

Defaults to center crop, overwritten by clientCropData if present.

Property Description
maxX

Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

maxY

Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

minX

Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

minY

Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

type

The type of object represented.

digitalDownloadPixels read-only

Max pixel dimension of the digital download.

digitalDownloadTypeId read-only

Ref ID noting the digital download type.

eventAlbumId

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

filterType

Filter applied to the photo for creation of this item.

fulfillmentType read-only

Slugs description of the order item fulfillment type.

groupId read-only

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

groupName read-only

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

id read-only

The identifier for this order item, a UUID.

isAlbumFiles read-only

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

isAllFiles read-only

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

isLowPhotoDpi nullable read-only

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

labCatalogProductId

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

labProductRetailPrice read-only

The retail price of this item in the lab catalog.

name

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

origin

Indicates the origin of the item in the order. Default is 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

Pre-discount retail price of the item.

photo read-only

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

photoDpi nullable read-only

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

photoId

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

price read-only

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

quantity

Number of instances of this item appearing in the order.

size read-only

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

status read-only

The item status.

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."
  }
}

Partially updates an order item.

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

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

orderItemId required

The order item identifier.

Header Parameters

Property Description
Authentication required

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

The (optional) alternate display name for this item.

cropData required nullable

Defaults to center crop, overwritten by clientCropData if present.

Property Description
maxX

Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

maxY

Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

minX

Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

minY

Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

type

The type of object represented.

eventAlbumId

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

filterType

Filter applied to the photo for creation of this item.

labCatalogProductId

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

name

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

origin

Indicates the origin of the item in the order. Default is 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

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

quantity

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
}

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

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

altDisplayName

The (optional) alternate display name for this item.

approved read-only

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

approvedDate nullable read-only

The date the item was approved.

clientCropData required nullable read-only

Customer selected crop data, overwrites default crop if provided.

clientNotes read-only

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

created nullable read-only

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

cropData required nullable

Defaults to center crop, overwritten by clientCropData if present.

Property Description
maxX

Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

maxY

Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

minX

Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

minY

Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

type

The type of object represented.

digitalDownloadPixels read-only

Max pixel dimension of the digital download.

digitalDownloadTypeId read-only

Ref ID noting the digital download type.

eventAlbumId

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

filterType

Filter applied to the photo for creation of this item.

fulfillmentType read-only

Slugs description of the order item fulfillment type.

groupId read-only

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

groupName read-only

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

id read-only

The identifier for this order item, a UUID.

isAlbumFiles read-only

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

isAllFiles read-only

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

isLowPhotoDpi nullable read-only

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

labCatalogProductId

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

labProductRetailPrice read-only

The retail price of this item in the lab catalog.

name

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

origin

Indicates the origin of the item in the order. Default is 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

Pre-discount retail price of the item.

photo read-only

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

photoDpi nullable read-only

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

photoId

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

price read-only

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

quantity

Number of instances of this item appearing in the order.

size read-only

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

status read-only

The item status.

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

A longer description of of the error encountered.

info

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

Property Description
errors

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

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

The HTTP status code associated with this error.

title

A short description of the error encountered.

type

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"
  }
}

Fully updates an order item.

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

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

orderItemId required

The order item identifier.

Header Parameters

Property Description
Authentication required

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

The (optional) alternate display name for this item.

cropData required nullable

Defaults to center crop, overwritten by clientCropData if present.

Property Description
maxX

Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

maxY

Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

minX

Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

minY

Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

type

The type of object represented.

eventAlbumId

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

filterType

Filter applied to the photo for creation of this item.

labCatalogProductId

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

name

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

origin

Indicates the origin of the item in the order. Default is 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

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

quantity

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
}

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

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

altDisplayName

The (optional) alternate display name for this item.

approved read-only

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

approvedDate nullable read-only

The date the item was approved.

clientCropData required nullable read-only

Customer selected crop data, overwrites default crop if provided.

clientNotes read-only

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

created nullable read-only

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

cropData required nullable

Defaults to center crop, overwritten by clientCropData if present.

Property Description
maxX

Horizontal position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

maxY

Vertical position of bottom right corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

minX

Horizontal position of top left corner of crop, expressed as a percentage (Float, 1-100), from left edge (x = 0) of image.

minY

Vertical position of top left corner of crop, expressed as a percentage (Float, 1-100), from top edge (y = 0) of image.

type

The type of object represented.

digitalDownloadPixels read-only

Max pixel dimension of the digital download.

digitalDownloadTypeId read-only

Ref ID noting the digital download type.

eventAlbumId

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

filterType

Filter applied to the photo for creation of this item.

fulfillmentType read-only

Slugs description of the order item fulfillment type.

groupId read-only

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

groupName read-only

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

id read-only

The identifier for this order item, a UUID.

isAlbumFiles read-only

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

isAllFiles read-only

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

isLowPhotoDpi nullable read-only

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

labCatalogProductId

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

labProductRetailPrice read-only

The retail price of this item in the lab catalog.

name

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

origin

Indicates the origin of the item in the order. Default is 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

Pre-discount retail price of the item.

photo read-only

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

photoDpi nullable read-only

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

photoId

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

price read-only

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

quantity

Number of instances of this item appearing in the order.

size read-only

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

status read-only

The item status.

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

A longer description of of the error encountered.

info

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

Property Description
errors

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

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

The HTTP status code associated with this error.

title

A short description of the error encountered.

type

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"
  }
}

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

Example Request

Path Parameters

Property Description
brandId required

The brand identifier.

orderId required

The order identifier.

Header Parameters

Property Description
Authentication required

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.

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

A collection of resources returned in the current result set.

Property Description
amount

The amount of this payment.

billingPostalCode

The billing address postal code. May be null for order payments made prior to the introduction of this value.

checkNumber nullable

If this payment was made by check, the check number for the payment.

created read-only

The date on which this payment was logged in the system.

currencyCode read-only

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

The currency symbol for the currency used for this payment.

emailAddress

The email address for the person making the payment.

id

The identifier for this order payment.

isPaymentOnHold nullable read-only

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

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

Whether the payment is able to be refunded.

nameOnCard

The card-holder name.

note nullable

A note about the payment.

paymentDate

The date on which this payment was made.

paymentFundsType

The type of funds received for this payment.

paymentReleasedDate nullable read-only

If isPaymentReleased is true, this indicates the date on which the payment was released.

type

The type of object represented.

links required read-only

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.

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

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/OrderClientPaymentCollection"
        }
      }
    },
    "description": "Order payment list response."
  }
}