<a class="sp-anchor" id="user-content-price-sheets" href="#price-sheets" aria-hidden="true"> Price Sheets

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

object

Metadata describing the current result set.

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

type

string

enum

lab-catalog-collection

The type of resource represented.

Error Response

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

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

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

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/LabCatalogCollection"
        }
      }
    },
    "description": "Lab catalog list response."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Returns a single lab catalog object by ID.

Returns a single lab catalog object for the brand by id.

get

/studio/brand/{brandId}/lab-catalog/{labCatalogId}

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Receiving the response

`200 OK`

A lab catalog object.

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
boundsDisplaySort	`string` enum width-height height-width Returns a slug that denotes whether width precedes height (or vice versa) when displaying bounds (e.g. 8" x 10" vs 10" x 8").
currencyCode nullable	`string` The type of currency used for this lab catalog, or `null` if this catalog has no currency code set.
currencySymbol nullable	`string` The currency symbol for the type of currency used for this lab catalog.
description deprecated	`string` Derived in the lab catalog transformer. Deprecated due to lack of translation.
id nullable	`integer` The identifier for this lab catalog, or `null` if this is the "empty" lab catalog.
isLabFulfilled	`boolean` Whether this represents a catalog of lab-fulfilled items.
lab nullable	`lab` Lab The lab to which this lab catalog belongs, or `null` if this is the "empty" lab catalog.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
type	`string` enum lab-catalog Type The type of resource represented.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/LabCatalog"
        }
      }
    },
    "description": "A lab catalog object."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

List all lab catalog groups for the lab catalog.

Returns a list of all lab catalog groups for the lab catalog.

Query string parameters may be used to affect the response, including pagination and sorting.

get

/studio/brand/{brandId}/lab-catalog/{labCatalogId}/group

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Receiving the response

`200 OK`

Lab Catalog Group 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

lab-catalog-group[]

Lab Catalog Group

A collection of resources returned in the current result set.

Property	Description
description nullable	`string` Display text shown to the user in order to give them information concerning the group and the type of products which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a lab catalog.
id	`integer` The identifier for the lab catalog group.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the lab catalog group.
type	`string` enum lab-catalog-group Type The type of resource represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

lab-catalog-group-collection

The type of resource represented.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/LabCatalogGroupCollection"
        }
      }
    },
    "description": "Lab Catalog Group list response."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Returns a lab catalog group for the lab catalog.

get

/studio/brand/{brandId}/lab-catalog/{labCatalogId}/group/{labCatalogGroupId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
labCatalogGroupId required	`integer` The lab catalog group identifier.
labCatalogId required	`integer` The lab catalog identifier.

Header Parameters

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

Receiving the response

`200 OK`

The lab catalog group

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
description nullable	`string` Display text shown to the user in order to give them information concerning the group and the type of products which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a lab catalog.
id	`integer` The identifier for the lab catalog group.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the lab catalog group.
type	`string` enum lab-catalog-group Type The type of resource represented.

`404 Not Found`

The requested resource could not be found.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/LabCatalogGroup"
        }
      }
    },
    "description": "The lab catalog group"
  },
  "404": {
    "$ref": "#/components/responses/notFoundError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

List all lab catalog products for the lab catalog.

Returns a list of all lab catalog products for the lab catalog.

Query string parameters may be used to affect the response, including pagination, sorting, and filtering.

get

/studio/brand/{brandId}/lab-catalog/{labCatalogId}/product

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Query Parameters

Property	Description
filterGroupType	`string` enum prints canvas digitals products metals fine-art custom packages The type of group by which to filter the results.
filterIsBestseller	`boolean` If provided and truthy, denotes that results should be filtered to only bestsellers.
filterLabCatalogGroupId	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier Group identifier by which to filter results.

Header Parameters

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

Receiving the response

`200 OK`

Lab Catalog Products 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

lab-catalog-product[]

Lab Catalog Product

A collection of resources returned in the current result set.

Property	Description
alternateDisplayName nullable	`string` An alternate name for the product.
bounds	`string` A comma delimited list that specifies the product bounds.
boundsName nullable	`string` The name given to the bounds description for the product.
description nullable	`string` Display text shown to the user in order to give them information concerning the product.
id	`integer` The identifier for the lab catalog product.
isBestseller	`boolean` Denotes if the item is a best seller, meaning that the product should appear in a new price sheet that is created with the 'Best Seller' option selected.
labCatalogGroupId nullable	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the lab catalog product.
productSize nullable	`string` The size of the product in human readable terms.
retailPrice	`number` A decimal value of the retail price of the product.
type	`string` enum lab-catalog-product Type The type of resource represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

lab-catalog-product-collection

Lab Catalog Shipping Option

The type of resource represented.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/LabCatalogProductCollection"
        }
      }
    },
    "description": "Lab Catalog Products list response."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Returns a lab catalog product for the lab catalog.

get

/studio/brand/{brandId}/lab-catalog/{labCatalogId}/product/{labCatalogProductId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
labCatalogId required	`integer` The lab catalog identifier.
labCatalogProductId required	`integer` The lab catalog product identifier.

Header Parameters

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

Receiving the response

`200 OK`

The lab catalog product

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
alternateDisplayName nullable	`string` An alternate name for the product.
bounds	`string` A comma delimited list that specifies the product bounds.
boundsName nullable	`string` The name given to the bounds description for the product.
description nullable	`string` Display text shown to the user in order to give them information concerning the product.
id	`integer` The identifier for the lab catalog product.
isBestseller	`boolean` Denotes if the item is a best seller, meaning that the product should appear in a new price sheet that is created with the 'Best Seller' option selected.
labCatalogGroupId nullable	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the lab catalog product.
productSize nullable	`string` The size of the product in human readable terms.
retailPrice	`number` A decimal value of the retail price of the product.
type	`string` enum lab-catalog-product Type The type of resource represented.

`404 Not Found`

The requested resource could not be found.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/LabCatalogProduct"
        }
      }
    },
    "description": "The lab catalog product"
  },
  "404": {
    "$ref": "#/components/responses/notFoundError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

List all lab catalog shipping options for the lab catalog.

Returns a list of all lab catalog shipping options for the lab catalog.

Query string parameters may be used to affect the response, including pagination and sorting.

get

/studio/brand/{brandId}/lab-catalog/{labCatalogId}/shipping-option

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Receiving the response

`200 OK`

Lab Catalog Shipping Option 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

lab-catalog-shipping-option[]

A collection of resources returned in the current result set.

Property Description

citiesAvailable nullable

string[]

An array of destination cities or localities where this shipping option is available. Applicable to couriers.

countryCode nullable

string

Two-character ISO-3166 code identifying the destination country where this shipping option is available.

description nullable

string

Display text shown to the user in order to give them information concerning the shipping option.

hasTracking

boolean

Is tracking available for this method?

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

labShippingCode

string

Code used by the lab to identify this shipping option.

links required read-only

object

maximumLabCost

number

A decimal value of the maximum lab cost available to utilize this shipping option, converted to the currency of the brand.

maximumProductSize required nullable

object

An object that specifies the maximum product size for this shipping option in inches.

Property	Description
height	`number` The number of inches of maximum height.
width	`number` The number of inches of maximum width.

minimumLabCost

number

A decimal value of the minimum lab cost required to utilize this shipping option, converted to the currency of the brand.

name

string

The name of the lab catalog shipping option.

printsOnly

boolean

Is this option available only for prints? Applicable to postal services with package size/weight limits.

retailPrice

number

A decimal value of the retail price of the shipping option, converted to the currency of the brand.

transitDays

string

General description of number of transit days.

type

string

enum

lab-catalog-shipping-option

The type of resource represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

lab-catalog-shipping-option-collection

The type of resource represented.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/LabCatalogShippingOptionCollection"
        }
      }
    },
    "description": "Lab Catalog Shipping Option list response."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Returns a lab catalog shipping option for the lab catalog.

get

/studio/brand/{brandId}/lab-catalog/{labCatalogId}/shipping-option/{labCatalogShippingOptionId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
labCatalogId required	`integer` The lab catalog identifier.
labCatalogShippingOptionId required	`integer` The lab catalog shipping option identifier.

Header Parameters

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

Receiving the response

`200 OK`

The lab catalog shipping option

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

citiesAvailable nullable

string[]

An array of destination cities or localities where this shipping option is available. Applicable to couriers.

countryCode nullable

string

Two-character ISO-3166 code identifying the destination country where this shipping option is available.

description nullable

string

Display text shown to the user in order to give them information concerning the shipping option.

hasTracking

boolean

Is tracking available for this method?

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

labShippingCode

string

Code used by the lab to identify this shipping option.

links required read-only

object

maximumLabCost

number

A decimal value of the maximum lab cost available to utilize this shipping option, converted to the currency of the brand.

maximumProductSize required nullable

object

An object that specifies the maximum product size for this shipping option in inches.

Property	Description
height	`number` The number of inches of maximum height.
width	`number` The number of inches of maximum width.

minimumLabCost

number

A decimal value of the minimum lab cost required to utilize this shipping option, converted to the currency of the brand.

name

string

The name of the lab catalog shipping option.

printsOnly

boolean

Is this option available only for prints? Applicable to postal services with package size/weight limits.

retailPrice

number

A decimal value of the retail price of the shipping option, converted to the currency of the brand.

transitDays

string

General description of number of transit days.

type

string

enum

lab-catalog-shipping-option

The type of resource represented.

`404 Not Found`

The requested resource could not be found.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/LabCatalogShippingOption"
        }
      }
    },
    "description": "The lab catalog shipping option"
  },
  "404": {
    "$ref": "#/components/responses/notFoundError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Lists all price sheets for the studio.

Returns a list of all price sheets for the studio. Price sheets are shared across all brands in the studio.

Query string parameters may be used to affect the response, including pagination, sorting, and filtering.

get

/studio/brand/{brandId}/price-sheet

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

`200 OK`

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

price-sheet[]

Price Sheet In List

A collection of resources returned in the current result set.

Property	Description
created	`string` date-time The creation date of this price sheet.
discountsCount	`integer` The total number of discounts associated with the price sheet.
fulfillmentLabId	`string` The id of the lab used to fulfill items purchased from the price sheet.
id	`integer` The identifier for this price sheet.
itemsCount	`integer` The total number of items the price sheet contains.
labCatalogId nullable	`integer` The ID of the lab catalog which the price sheet is based on
linkedCartsCount read-only	`integer` The total number of carts containing items in the price sheet.
linkedEventDefaultsCount read-only	`integer` The total number of Brand Events Defaults using this Price Sheet.
linkedEventsCount read-only	`integer` The total number of non-deleted events that are using the price sheet.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` Human readable name for this price sheet.
packageCount read-only	`integer` The total number of packages in the price sheet.
type	`string` enum price-sheet The type of object represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

price-sheet-collection

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/PriceSheetCollection"
        }
      }
    },
    "description": "Price sheet list response."
  }
}

Creates a new price sheet object for the current studio.

Creates a new Price Sheet.

In order to duplicate an existing Price Sheet object, the request must contain a duplicatesId parameter containing the ID of the Price Sheet that is to be duplicated. In this case, a request body is optional. When the request is submitted the request body will be merged onto the duplicated resource, replacing any properties.

post

/studio/brand/{brandId}/price-sheet

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Query Parameters

Property	Description
duplicatesId	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier Price Sheet identifier to duplicate

Header Parameters

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

Request Body

The price sheet.

application/vnd.shootproof+json

Property Description

allowLabShippingSpeedSelection

boolean

Determines if the client should be allowed to select a shipping speed offered by the lab during checkout

createdFromBestsellers

boolean

Denotes if the price sheet was originally created with auto-populate items from the lab catalog's best seller's list.

labCatalogId nullable

integer

The ID of the lab catalog which the price sheet is based on

name

string

The name of the price sheet.

priceSheetGroups

price-sheet-group[]

An array of group of items that are contained by the price sheet.

retouch required nullable

object

Setting for Retouch add-on, an optional add-on that is applied across all items of the price sheet.

Property	Description
description	`string` Text to describe the retouch add-on to customers.
label	`string` Label of the retouch add-on as it will be displayed to the user.
position	`string` enum first last Denotes if the retouch add-on should be the first or last add-on displayed for items of the price sheet.
price	`number` The cost for performing retouches to item images.

salesTaxOnDigitalDownload

boolean

Denotes if the sales tax should be applied to items which are solely a digital download.

salesTaxOnShippingCharge

boolean

Denotes if the sales tax should be applied to shipping fees.

salesTaxPercentage nullable

number

The percentage used to calculate the sales tax from an order subtotal.

salesTaxStateId nullable

string

An identifier signifying the state or locale where the sales tax is applicable. The identifier is a combination of the two letter country code and a two to three letter abbreviation of the state/locale separated by an underscore.

salesTaxTitle nullable

string

A name used to refer to the tax.

selfFulfilledLabCatalogId nullable

integer

The ID of the self-fulfilled catalog which the price sheet uses.

shippingOptions nullable

object[]

An array of shipping options to be used when purchasing items from the price sheet.

Property	Description
price	`number` Decimal value of the price of the shipping option.
title	`string` The display title of the shipping option.

shippingTitle nullable

string

A descriptive title for shipping, such as "Shipping", "Shipping and Handling", etc.

shippingType

string

enum

custom-options
lab-shipping-costs

What type of shipping does the price sheet expect to use.

taxProfileId nullable

number

Id of a tax profile to associate with the price sheet. The properties of the tax profile such as tax rate, application to shipping/digital items, and localities will apply to items purchased from the price sheet.

termsOfSale nullable

string

Terms of sale which users must agree to before being allowed to purchase items from the price sheet. Providing a null removes any existing terms of sale.

type

string

enum

price-sheet

The type of object represented.

vatNumber nullable

string

VAT identification number (VATIN) used by many EU and other countries for tax entity identification purposes.

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/PriceSheet"
      }
    }
  },
  "description": "The price sheet.",
  "required": true
}

Receiving the response

`201 Created`

The successfully created price sheet object.

Headers

Header	Description
Location	`string` uri The URL to the newly-created price sheet object.

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

allowLabShippingSpeedSelection

boolean

Determines if the client should be allowed to select a shipping speed offered by the lab during checkout

created read-only

string

date-time

The creation date of this price sheet.

createdFromBestsellers

boolean

Denotes if the price sheet was originally created with auto-populate items from the lab catalog's best seller's list.

id read-only

integer

The identifier for the price sheet.

labCatalogId nullable

integer

The ID of the lab catalog which the price sheet is based on

linkedCartsCount read-only

integer

The total number of carts containing items in the price sheet.

linkedEventDefaultsCount read-only

integer

The total number of events defaults using this price sheet.

linkedEventsCount read-only

integer

The total number of non-deleted events that are using the price sheet.

links required read-only

object

name

string

The name of the price sheet.

packageCount read-only

integer

The total number of packages in the price sheet.

priceSheetGroups

price-sheet-group[]

An array of group of items that are contained by the price sheet.

retouch required nullable

object

Setting for Retouch add-on, an optional add-on that is applied across all items of the price sheet.

Property	Description
description	`string` Text to describe the retouch add-on to customers.
label	`string` Label of the retouch add-on as it will be displayed to the user.
position	`string` enum first last Denotes if the retouch add-on should be the first or last add-on displayed for items of the price sheet.
price	`number` The cost for performing retouches to item images.

salesTaxOnDigitalDownload

boolean

Denotes if the sales tax should be applied to items which are solely a digital download.

salesTaxOnShippingCharge

boolean

Denotes if the sales tax should be applied to shipping fees.

salesTaxPercentage nullable

number

The percentage used to calculate the sales tax from an order subtotal.

salesTaxStateId nullable

string

salesTaxTitle nullable

string

A name used to refer to the tax.

selfFulfilledLabCatalogId nullable

integer

The ID of the self-fulfilled catalog which the price sheet uses.

shippingOptions nullable

object[]

An array of shipping options to be used when purchasing items from the price sheet.

Property	Description
price	`number` Decimal value of the price of the shipping option.
title	`string` The display title of the shipping option.

shippingTitle nullable

string

A descriptive title for shipping, such as "Shipping", "Shipping and Handling", etc.

shippingType

string

enum

custom-options
lab-shipping-costs

What type of shipping does the price sheet expect to use.

taxProfileId nullable

number

termsOfSale nullable

string

Terms of sale which users must agree to before being allowed to purchase items from the price sheet. Providing a null removes any existing terms of sale.

type

string

enum

price-sheet

The type of object represented.

vatNumber nullable

string

VAT identification number (VATIN) used by many EU and other countries for tax entity identification purposes.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

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

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

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

Removes a single price sheet object from the studio.

Changes the status of a studio's price sheet to deleted.

delete

/studio/brand/{brandId}/price-sheet/{priceSheetId}

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Receiving the response

204
Schema

`204 No Content`

Successful deletion response.

OpenAPI Schema

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

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

Returns a single price sheet object by ID.

Returns a specific price sheet for the studio using the price sheet ID.

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Receiving the response

`200 OK`

A price sheet object.

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

allowLabShippingSpeedSelection

boolean

Determines if the client should be allowed to select a shipping speed offered by the lab during checkout

created read-only

string

date-time

The creation date of this price sheet.

createdFromBestsellers

boolean

Denotes if the price sheet was originally created with auto-populate items from the lab catalog's best seller's list.

id read-only

integer

The identifier for the price sheet.

labCatalogId nullable

integer

The ID of the lab catalog which the price sheet is based on

linkedCartsCount read-only

integer

The total number of carts containing items in the price sheet.

linkedEventDefaultsCount read-only

integer

The total number of events defaults using this price sheet.

linkedEventsCount read-only

integer

The total number of non-deleted events that are using the price sheet.

links required read-only

object

name

string

The name of the price sheet.

packageCount read-only

integer

The total number of packages in the price sheet.

priceSheetGroups

price-sheet-group[]

An array of group of items that are contained by the price sheet.

retouch required nullable

object

Setting for Retouch add-on, an optional add-on that is applied across all items of the price sheet.

Property	Description
description	`string` Text to describe the retouch add-on to customers.
label	`string` Label of the retouch add-on as it will be displayed to the user.
position	`string` enum first last Denotes if the retouch add-on should be the first or last add-on displayed for items of the price sheet.
price	`number` The cost for performing retouches to item images.

salesTaxOnDigitalDownload

boolean

Denotes if the sales tax should be applied to items which are solely a digital download.

salesTaxOnShippingCharge

boolean

Denotes if the sales tax should be applied to shipping fees.

salesTaxPercentage nullable

number

The percentage used to calculate the sales tax from an order subtotal.

salesTaxStateId nullable

string

salesTaxTitle nullable

string

A name used to refer to the tax.

selfFulfilledLabCatalogId nullable

integer

The ID of the self-fulfilled catalog which the price sheet uses.

shippingOptions nullable

object[]

An array of shipping options to be used when purchasing items from the price sheet.

Property	Description
price	`number` Decimal value of the price of the shipping option.
title	`string` The display title of the shipping option.

shippingTitle nullable

string

A descriptive title for shipping, such as "Shipping", "Shipping and Handling", etc.

shippingType

string

enum

custom-options
lab-shipping-costs

What type of shipping does the price sheet expect to use.

taxProfileId nullable

number

termsOfSale nullable

string

Terms of sale which users must agree to before being allowed to purchase items from the price sheet. Providing a null removes any existing terms of sale.

type

string

enum

price-sheet

The type of object represented.

vatNumber nullable

string

VAT identification number (VATIN) used by many EU and other countries for tax entity identification purposes.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheet"
        }
      }
    },
    "description": "A price sheet object."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially updates a price sheet.

This endpoint is still under development. A mocked update response will be returned, but the updates will not actually be saved. Updates the provided fields for the price sheet, exception those indicated as readOnly.

patch

/studio/brand/{brandId}/price-sheet/{priceSheetId}

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Request Body

The price sheet object to update. Only proviude those properties that need updating.

application/vnd.shootproof+json

Property Description

allowLabShippingSpeedSelection

boolean

Determines if the client should be allowed to select a shipping speed offered by the lab during checkout

createdFromBestsellers

boolean

Denotes if the price sheet was originally created with auto-populate items from the lab catalog's best seller's list.

labCatalogId nullable

integer

The ID of the lab catalog which the price sheet is based on

name

string

The name of the price sheet.

priceSheetGroups

price-sheet-group[]

An array of group of items that are contained by the price sheet.

retouch required nullable

object

Setting for Retouch add-on, an optional add-on that is applied across all items of the price sheet.

Property	Description
description	`string` Text to describe the retouch add-on to customers.
label	`string` Label of the retouch add-on as it will be displayed to the user.
position	`string` enum first last Denotes if the retouch add-on should be the first or last add-on displayed for items of the price sheet.
price	`number` The cost for performing retouches to item images.

salesTaxOnDigitalDownload

boolean

Denotes if the sales tax should be applied to items which are solely a digital download.

salesTaxOnShippingCharge

boolean

Denotes if the sales tax should be applied to shipping fees.

salesTaxPercentage nullable

number

The percentage used to calculate the sales tax from an order subtotal.

salesTaxStateId nullable

string

salesTaxTitle nullable

string

A name used to refer to the tax.

selfFulfilledLabCatalogId nullable

integer

The ID of the self-fulfilled catalog which the price sheet uses.

shippingOptions nullable

object[]

An array of shipping options to be used when purchasing items from the price sheet.

Property	Description
price	`number` Decimal value of the price of the shipping option.
title	`string` The display title of the shipping option.

shippingTitle nullable

string

A descriptive title for shipping, such as "Shipping", "Shipping and Handling", etc.

shippingType

string

enum

custom-options
lab-shipping-costs

What type of shipping does the price sheet expect to use.

taxProfileId nullable

number

termsOfSale nullable

string

Terms of sale which users must agree to before being allowed to purchase items from the price sheet. Providing a null removes any existing terms of sale.

type

string

enum

price-sheet

The type of object represented.

vatNumber nullable

string

VAT identification number (VATIN) used by many EU and other countries for tax entity identification purposes.

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/PriceSheet"
      }
    }
  },
  "description": "The price sheet object to update. Only proviude those properties that\nneed updating.",
  "required": true
}

Receiving the response

`200 OK`

The successfully updated price sheet.

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

allowLabShippingSpeedSelection

boolean

Determines if the client should be allowed to select a shipping speed offered by the lab during checkout

created read-only

string

date-time

The creation date of this price sheet.

createdFromBestsellers

boolean

Denotes if the price sheet was originally created with auto-populate items from the lab catalog's best seller's list.

id read-only

integer

The identifier for the price sheet.

labCatalogId nullable

integer

The ID of the lab catalog which the price sheet is based on

linkedCartsCount read-only

integer

The total number of carts containing items in the price sheet.

linkedEventDefaultsCount read-only

integer

The total number of events defaults using this price sheet.

linkedEventsCount read-only

integer

The total number of non-deleted events that are using the price sheet.

links required read-only

object

name

string

The name of the price sheet.

packageCount read-only

integer

The total number of packages in the price sheet.

priceSheetGroups

price-sheet-group[]

An array of group of items that are contained by the price sheet.

retouch required nullable

object

Setting for Retouch add-on, an optional add-on that is applied across all items of the price sheet.

Property	Description
description	`string` Text to describe the retouch add-on to customers.
label	`string` Label of the retouch add-on as it will be displayed to the user.
position	`string` enum first last Denotes if the retouch add-on should be the first or last add-on displayed for items of the price sheet.
price	`number` The cost for performing retouches to item images.

salesTaxOnDigitalDownload

boolean

Denotes if the sales tax should be applied to items which are solely a digital download.

salesTaxOnShippingCharge

boolean

Denotes if the sales tax should be applied to shipping fees.

salesTaxPercentage nullable

number

The percentage used to calculate the sales tax from an order subtotal.

salesTaxStateId nullable

string

salesTaxTitle nullable

string

A name used to refer to the tax.

selfFulfilledLabCatalogId nullable

integer

The ID of the self-fulfilled catalog which the price sheet uses.

shippingOptions nullable

object[]

An array of shipping options to be used when purchasing items from the price sheet.

Property	Description
price	`number` Decimal value of the price of the shipping option.
title	`string` The display title of the shipping option.

shippingTitle nullable

string

A descriptive title for shipping, such as "Shipping", "Shipping and Handling", etc.

shippingType

string

enum

custom-options
lab-shipping-costs

What type of shipping does the price sheet expect to use.

taxProfileId nullable

number

termsOfSale nullable

string

Terms of sale which users must agree to before being allowed to purchase items from the price sheet. Providing a null removes any existing terms of sale.

type

string

enum

price-sheet

The type of object represented.

vatNumber nullable

string

VAT identification number (VATIN) used by many EU and other countries for tax entity identification purposes.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

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

Fully updates a specific studio price sheet.

Updates the specified price sheet using the provided data with the entire price sheet being overwritten.

put

/studio/brand/{brandId}/price-sheet/{priceSheetId}

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Request Body

The price sheet.

application/vnd.shootproof+json

Property Description

allowLabShippingSpeedSelection

boolean

Determines if the client should be allowed to select a shipping speed offered by the lab during checkout

createdFromBestsellers

boolean

Denotes if the price sheet was originally created with auto-populate items from the lab catalog's best seller's list.

labCatalogId nullable

integer

The ID of the lab catalog which the price sheet is based on

name

string

The name of the price sheet.

priceSheetGroups

price-sheet-group[]

An array of group of items that are contained by the price sheet.

retouch required nullable

object

Setting for Retouch add-on, an optional add-on that is applied across all items of the price sheet.

Property	Description
description	`string` Text to describe the retouch add-on to customers.
label	`string` Label of the retouch add-on as it will be displayed to the user.
position	`string` enum first last Denotes if the retouch add-on should be the first or last add-on displayed for items of the price sheet.
price	`number` The cost for performing retouches to item images.

salesTaxOnDigitalDownload

boolean

Denotes if the sales tax should be applied to items which are solely a digital download.

salesTaxOnShippingCharge

boolean

Denotes if the sales tax should be applied to shipping fees.

salesTaxPercentage nullable

number

The percentage used to calculate the sales tax from an order subtotal.

salesTaxStateId nullable

string

salesTaxTitle nullable

string

A name used to refer to the tax.

selfFulfilledLabCatalogId nullable

integer

The ID of the self-fulfilled catalog which the price sheet uses.

shippingOptions nullable

object[]

An array of shipping options to be used when purchasing items from the price sheet.

Property	Description
price	`number` Decimal value of the price of the shipping option.
title	`string` The display title of the shipping option.

shippingTitle nullable

string

A descriptive title for shipping, such as "Shipping", "Shipping and Handling", etc.

shippingType

string

enum

custom-options
lab-shipping-costs

What type of shipping does the price sheet expect to use.

taxProfileId nullable

number

termsOfSale nullable

string

Terms of sale which users must agree to before being allowed to purchase items from the price sheet. Providing a null removes any existing terms of sale.

type

string

enum

price-sheet

The type of object represented.

vatNumber nullable

string

VAT identification number (VATIN) used by many EU and other countries for tax entity identification purposes.

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/PriceSheet"
      }
    }
  },
  "description": "The price sheet.",
  "required": true
}

Receiving the response

`200 OK`

The successfully updated price sheet.

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

allowLabShippingSpeedSelection

boolean

Determines if the client should be allowed to select a shipping speed offered by the lab during checkout

created read-only

string

date-time

The creation date of this price sheet.

createdFromBestsellers

boolean

Denotes if the price sheet was originally created with auto-populate items from the lab catalog's best seller's list.

id read-only

integer

The identifier for the price sheet.

labCatalogId nullable

integer

The ID of the lab catalog which the price sheet is based on

linkedCartsCount read-only

integer

The total number of carts containing items in the price sheet.

linkedEventDefaultsCount read-only

integer

The total number of events defaults using this price sheet.

linkedEventsCount read-only

integer

The total number of non-deleted events that are using the price sheet.

links required read-only

object

name

string

The name of the price sheet.

packageCount read-only

integer

The total number of packages in the price sheet.

priceSheetGroups

price-sheet-group[]

An array of group of items that are contained by the price sheet.

retouch required nullable

object

Setting for Retouch add-on, an optional add-on that is applied across all items of the price sheet.

Property	Description
description	`string` Text to describe the retouch add-on to customers.
label	`string` Label of the retouch add-on as it will be displayed to the user.
position	`string` enum first last Denotes if the retouch add-on should be the first or last add-on displayed for items of the price sheet.
price	`number` The cost for performing retouches to item images.

salesTaxOnDigitalDownload

boolean

Denotes if the sales tax should be applied to items which are solely a digital download.

salesTaxOnShippingCharge

boolean

Denotes if the sales tax should be applied to shipping fees.

salesTaxPercentage nullable

number

The percentage used to calculate the sales tax from an order subtotal.

salesTaxStateId nullable

string

salesTaxTitle nullable

string

A name used to refer to the tax.

selfFulfilledLabCatalogId nullable

integer

The ID of the self-fulfilled catalog which the price sheet uses.

shippingOptions nullable

object[]

An array of shipping options to be used when purchasing items from the price sheet.

Property	Description
price	`number` Decimal value of the price of the shipping option.
title	`string` The display title of the shipping option.

shippingTitle nullable

string

A descriptive title for shipping, such as "Shipping", "Shipping and Handling", etc.

shippingType

string

enum

custom-options
lab-shipping-costs

What type of shipping does the price sheet expect to use.

taxProfileId nullable

number

termsOfSale nullable

string

Terms of sale which users must agree to before being allowed to purchase items from the price sheet. Providing a null removes any existing terms of sale.

type

string

enum

price-sheet

The type of object represented.

vatNumber nullable

string

VAT identification number (VATIN) used by many EU and other countries for tax entity identification purposes.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

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

Lists all discounts available for a price sheet.

Returns a list of all discounts available for the price sheet. Query string parameters may be used to affect the response, including pagination, sorting, and filtering.

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/discount

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Receiving the response

200
Schema

`200 OK`

Price sheet discounts 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

price-sheet-discount[]

Price Sheet Discount

A collection of resources returned in the current result set.

Property	Description
created read-only	`string` date-time The creation date of this price sheet.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the price sheet discount.
type	`string` enum price-sheet-discount Type The type of resource represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

price-sheet-discount-collection

The type of resource represented.

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/PriceSheetDiscountCollection"
        }
      }
    },
    "description": "Price sheet discounts list response."
  }
}

Returns a single price sheet discount object by ID.

Returns a specific price sheet discount using the ID of the discount.

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/discount/{priceSheetDiscountId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetDiscountId required	`integer` The pricesheet discount identifier.
priceSheetId required	`integer` The price sheet identifier.

Header Parameters

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

Receiving the response

`200 OK`

A price sheet discount object.

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
created read-only	`string` date-time The creation date of this price sheet.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the price sheet discount.
type	`string` enum price-sheet-discount Type The type of resource represented.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheetDiscountCollection/allOf/0/properties/items/items"
        }
      }
    },
    "description": "A price sheet discount object."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Lists all events which have been linked to the price sheet.

Returns a list of all events linked to the price sheet. Query string parameters may be used to affect the response, including pagination, sorting, and filtering.

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/event

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Receiving the response

200
Schema

`200 OK`

List of Events that are associated with the given PriceSheetId.

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

event[]

Event

A collection of resources returned in the current result set.

Property	Description
contactId nullable	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
contactName nullable	`string` The full name of the contact associated with this event.
coverPhoto required nullable read-only	`cover-photo` Cover Photo A cover photo for the event.
created	`string` date-time The creation date of this event.
createdBy	`integer` The ID of the user who created this event.
eventAccessLevel	`string` enum public-password public-no-password private-password private-no-password The event access level.
eventCategory nullable	`string` The human-readable name of the category of this event.
eventCategoryId nullable	`integer` The numeric identifier for the category of this event.
eventDate nullable	`string` date-time The date on which this event took place.
eventStatus	`string` enum active inactive archived The event status.
expirationDate nullable	`string` date-time The date on which this event expires.
id	`integer` The identifier for this event.
isPreRegistration	`boolean` Whether pre-registration mode is turned on for the event.
lastReleasedDate nullable	`string` date-time The date on which this event was last released.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of this event.
photosCount	`integer` The total number of photos within this event, including photos in albums.
playlistId nullable read-only	`integer` The identifier for the playlist this event uses.
priceSheetId nullable	`integer` The identifier for the price sheet assigned to the event.
releaseDate nullable	`string` date-time The date on which this event will be released.
type	`string` enum event The type of object represented.

links required read-only

object

meta required read-only

object

Metadata describing the current result set.

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

type

string

enum

event-collection

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/EventCollection"
        }
      }
    },
    "description": "List of Events that are associated with the given PriceSheetId."
  }
}

Lists all groups for the price sheet.

Returns a list of all Groups for the Price Sheet.

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Receiving the response

200
Schema

`200 OK`

Price Sheet Group 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

price-sheet-group[]

A collection of resources returned in the current result set.

Property	Description
created read-only	`string` date-time The creation date of this price sheet group.
description	`string` Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a price sheet
groupType read-only	`string` enum custom prints canvas digitals products metals fine-art The slug name of the type of price sheet item group.
id read-only	`integer` The identifier for the price sheet group.
images	`price-sheet-element-image[]` Price Sheet Element Image An array of images which display the types of items which may be contained within the group.
isDefault read-only	`boolean` Denotes if the group is a default group. Default groups are created when the Price Sheet is created and cannot be deleted.
isFeaturedType	`boolean` Denotes that the group is meant to contain items which are to be featured in the price sheet.
isPackageType	`boolean` Denotes that the group is meant to contain packages.
isSecondary read-only	`boolean` Denotes if the group is a secondary copy of a default group. The secondary group can contain the same lab-fulfilled product available to the default group, as long as the product is not already contained in the default group.
labCatalogGroupId	`integer` The ID of the lab catalog group which was used to create the group.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the price sheet group.
priceSheetItems	`[]` Price Sheet Item An array containing the items which are part of the group.
priceSheetSubgroups	`price-sheet-subgroup[]` Price Sheet Subgroup An array containing the various subgroups of items within the group.
status read-only	`string` enum active deleted The current status of the price sheet group.
type	`string` enum price-sheet-group The type of object represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

price-sheet-group-collection

The type of resource represented.

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/PriceSheetGroupCollection"
        }
      }
    },
    "description": "Price Sheet Group list response."
  }
}

Updates a batch of Price Sheet Groups.

Updates the provided properties on each of the given groups in the collection.

If a property on an individual item is omitted, then no change will be performed on that property. If, however, the property is provided and set to null, that property will be unset. Note that some properties may not be set to null.

patch

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Request Body

The list of groups to update.

application/vnd.shootproof+json

Property Description

items

object[]

A collection of one or more batched resources. If items is null or an empty array, no action is taken.

Property	Description
description	`string` Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a price sheet
id	`number[]` Identifies one or more resources for which changes may be applied. This property accepts several different types of values: `[]`: If the `id` property is an empty array, then the changes will apply to all resources applicable to the context of the operation. `number[]`: If the value is an array of integers, then the changes will apply to each of the resources identified by the numbers. If any of these numbers are negative (i.e., prefixed with a minus sign, `-`), the changes will not apply to resources identified by those numbers, even if the same number is present in the array in its positive form. `null` or not present: An undefined state. The changes will not be applied to any resources. This functionality allows a great degree of flexibility to batch processing of API resources. We can ask that the changes be applied to all resources for the given `type` by providing an empty array. We can apply the changes to all resources except a few (e.g., `"id": [-45, -76, -32]`). We can apply the changes to some resources, but not others (e.g., `"id": [-32, 56, 45, -6, 18, 32]`—in this example, the changes will not be applied to the resource identified by `32`).
isFeaturedType	`boolean` Denotes that the group is meant to contain items which are to be featured in the price sheet.
name	`string` The name of the price sheet group.
type	`string` The type of resource represented (i.e., `event`).

type

string

The model type for the collection object (i.e., event-collection).

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/PriceSheetGroupCollectionInPatch"
      }
    }
  },
  "description": "The list of groups to update.",
  "required": true
}

Receiving the response

`200 OK`

Price Sheet Group 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

price-sheet-group[]

A collection of resources returned in the current result set.

Property	Description
created read-only	`string` date-time The creation date of this price sheet group.
description	`string` Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a price sheet
groupType read-only	`string` enum custom prints canvas digitals products metals fine-art The slug name of the type of price sheet item group.
id read-only	`integer` The identifier for the price sheet group.
images	`price-sheet-element-image[]` Price Sheet Element Image An array of images which display the types of items which may be contained within the group.
isDefault read-only	`boolean` Denotes if the group is a default group. Default groups are created when the Price Sheet is created and cannot be deleted.
isFeaturedType	`boolean` Denotes that the group is meant to contain items which are to be featured in the price sheet.
isPackageType	`boolean` Denotes that the group is meant to contain packages.
isSecondary read-only	`boolean` Denotes if the group is a secondary copy of a default group. The secondary group can contain the same lab-fulfilled product available to the default group, as long as the product is not already contained in the default group.
labCatalogGroupId	`integer` The ID of the lab catalog group which was used to create the group.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the price sheet group.
priceSheetItems	`[]` Price Sheet Item An array containing the items which are part of the group.
priceSheetSubgroups	`price-sheet-subgroup[]` Price Sheet Subgroup An array containing the various subgroups of items within the group.
status read-only	`string` enum active deleted The current status of the price sheet group.
type	`string` enum price-sheet-group The type of object represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

price-sheet-group-collection

The type of resource represented.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheetGroupCollection"
        }
      }
    },
    "description": "Price Sheet Group list response."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Create a Price Sheet Group

Creates a new Price Sheet Group object for the current studio.

post

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Request Body

application/vnd.shootproof+json

Property	Description
description	`string` Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a price sheet
images	`price-sheet-element-image[]` Price Sheet Element Image An array of images which display the types of items which may be contained within the group.
isFeaturedType	`boolean` Denotes that the group is meant to contain items which are to be featured in the price sheet.
isPackageType	`boolean` Denotes that the group is meant to contain packages.
labCatalogGroupId	`integer` The ID of the lab catalog group which was used to create the group.
name	`string` The name of the price sheet group.
priceSheetItems	`[]` Price Sheet Item An array containing the items which are part of the group.
priceSheetSubgroups	`price-sheet-subgroup[]` Price Sheet Subgroup An array containing the various subgroups of items within the group.
type	`string` enum price-sheet-group The type of object 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/PriceSheetGroup"
      }
    }
  }
}

Receiving the response

`201 Created`

The successfully-created Price Sheet Group object.

Headers

Header	Description
Location	`string` uri The URL to the newly-created Price Sheet Group object.

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
created read-only	`string` date-time The creation date of this price sheet group.
description	`string` Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a price sheet
groupType read-only	`string` enum custom prints canvas digitals products metals fine-art The slug name of the type of price sheet item group.
id read-only	`integer` The identifier for the price sheet group.
images	`price-sheet-element-image[]` Price Sheet Element Image An array of images which display the types of items which may be contained within the group.
isDefault read-only	`boolean` Denotes if the group is a default group. Default groups are created when the Price Sheet is created and cannot be deleted.
isFeaturedType	`boolean` Denotes that the group is meant to contain items which are to be featured in the price sheet.
isPackageType	`boolean` Denotes that the group is meant to contain packages.
isSecondary read-only	`boolean` Denotes if the group is a secondary copy of a default group. The secondary group can contain the same lab-fulfilled product available to the default group, as long as the product is not already contained in the default group.
labCatalogGroupId	`integer` The ID of the lab catalog group which was used to create the group.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the price sheet group.
priceSheetItems	`[]` Price Sheet Item An array containing the items which are part of the group.
priceSheetSubgroups	`price-sheet-subgroup[]` Price Sheet Subgroup An array containing the various subgroups of items within the group.
status read-only	`string` enum active deleted The current status of the price sheet group.
type	`string` enum price-sheet-group The type of object represented.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

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

Removes a Price Sheet Group.

Removes a specific Group from the Price Sheet.

delete

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group/{priceSheetGroupId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetGroupId required	`integer` The pricesheet group identifier.
priceSheetId required	`integer` The price sheet identifier.

Header Parameters

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

Receiving the response

204
Schema

`204 No Content`

Successful deletion response.

OpenAPI Schema

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

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

Returns a single Price Sheet Group object by ID.

Returns a specific Price Sheet Group using the ID of the group.

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group/{priceSheetGroupId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetGroupId required	`integer` The pricesheet group identifier.
priceSheetId required	`integer` The price sheet identifier.

Header Parameters

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

Receiving the response

`200 OK`

A Price Sheet Group object.

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
created read-only	`string` date-time The creation date of this price sheet group.
description	`string` Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a price sheet
groupType read-only	`string` enum custom prints canvas digitals products metals fine-art The slug name of the type of price sheet item group.
id read-only	`integer` The identifier for the price sheet group.
images	`price-sheet-element-image[]` Price Sheet Element Image An array of images which display the types of items which may be contained within the group.
isDefault read-only	`boolean` Denotes if the group is a default group. Default groups are created when the Price Sheet is created and cannot be deleted.
isFeaturedType	`boolean` Denotes that the group is meant to contain items which are to be featured in the price sheet.
isPackageType	`boolean` Denotes that the group is meant to contain packages.
isSecondary read-only	`boolean` Denotes if the group is a secondary copy of a default group. The secondary group can contain the same lab-fulfilled product available to the default group, as long as the product is not already contained in the default group.
labCatalogGroupId	`integer` The ID of the lab catalog group which was used to create the group.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the price sheet group.
priceSheetItems	`[]` Price Sheet Item An array containing the items which are part of the group.
priceSheetSubgroups	`price-sheet-subgroup[]` Price Sheet Subgroup An array containing the various subgroups of items within the group.
status read-only	`string` enum active deleted The current status of the price sheet group.
type	`string` enum price-sheet-group The type of object represented.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheetGroup"
        }
      }
    },
    "description": "A Price Sheet Group object."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially updates a Price Sheet Group.

Updates a Price Sheet Group with only the provided fields being updated.

patch

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group/{priceSheetGroupId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetGroupId required	`integer` The pricesheet group identifier.
priceSheetId required	`integer` The price sheet identifier.

Header Parameters

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

Request Body

The price sheet group object to partially update.

application/vnd.shootproof+json

Property	Description
description	`string` Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a price sheet
images	`price-sheet-element-image[]` Price Sheet Element Image An array of images which display the types of items which may be contained within the group.
isFeaturedType	`boolean` Denotes that the group is meant to contain items which are to be featured in the price sheet.
isPackageType	`boolean` Denotes that the group is meant to contain packages.
labCatalogGroupId	`integer` The ID of the lab catalog group which was used to create the group.
name	`string` The name of the price sheet group.
priceSheetItems	`[]` Price Sheet Item An array containing the items which are part of the group.
priceSheetSubgroups	`price-sheet-subgroup[]` Price Sheet Subgroup An array containing the various subgroups of items within the group.
type	`string` enum price-sheet-group The type of object 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/PriceSheetGroup"
      }
    }
  },
  "description": "The price sheet group object to partially update.",
  "required": true
}

Receiving the response

`200 OK`

The successfully updated Price Sheet Group.

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
created read-only	`string` date-time The creation date of this price sheet group.
description	`string` Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a price sheet
groupType read-only	`string` enum custom prints canvas digitals products metals fine-art The slug name of the type of price sheet item group.
id read-only	`integer` The identifier for the price sheet group.
images	`price-sheet-element-image[]` Price Sheet Element Image An array of images which display the types of items which may be contained within the group.
isDefault read-only	`boolean` Denotes if the group is a default group. Default groups are created when the Price Sheet is created and cannot be deleted.
isFeaturedType	`boolean` Denotes that the group is meant to contain items which are to be featured in the price sheet.
isPackageType	`boolean` Denotes that the group is meant to contain packages.
isSecondary read-only	`boolean` Denotes if the group is a secondary copy of a default group. The secondary group can contain the same lab-fulfilled product available to the default group, as long as the product is not already contained in the default group.
labCatalogGroupId	`integer` The ID of the lab catalog group which was used to create the group.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the price sheet group.
priceSheetItems	`[]` Price Sheet Item An array containing the items which are part of the group.
priceSheetSubgroups	`price-sheet-subgroup[]` Price Sheet Subgroup An array containing the various subgroups of items within the group.
status read-only	`string` enum active deleted The current status of the price sheet group.
type	`string` enum price-sheet-group The type of object represented.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheetGroup"
        }
      }
    },
    "description": "The successfully updated Price Sheet Group."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Fully updates a specific Price Sheet Group.

Updates the specified Price Sheet Group using the provided data with the entire item being overwritten.

put

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group/{priceSheetGroupId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetGroupId required	`integer` The pricesheet group identifier.
priceSheetId required	`integer` The price sheet identifier.

Header Parameters

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

Request Body

The price sheet group object to update.

application/vnd.shootproof+json

Property	Description
description	`string` Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a price sheet
images	`price-sheet-element-image[]` Price Sheet Element Image An array of images which display the types of items which may be contained within the group.
isFeaturedType	`boolean` Denotes that the group is meant to contain items which are to be featured in the price sheet.
isPackageType	`boolean` Denotes that the group is meant to contain packages.
labCatalogGroupId	`integer` The ID of the lab catalog group which was used to create the group.
name	`string` The name of the price sheet group.
priceSheetItems	`[]` Price Sheet Item An array containing the items which are part of the group.
priceSheetSubgroups	`price-sheet-subgroup[]` Price Sheet Subgroup An array containing the various subgroups of items within the group.
type	`string` enum price-sheet-group The type of object 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/PriceSheetGroup"
      }
    }
  },
  "description": "The price sheet group object to update.",
  "required": true
}

Receiving the response

`200 OK`

The successfully updated Price Sheet Group.

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
created read-only	`string` date-time The creation date of this price sheet group.
description	`string` Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.
displayOrder	`integer` The order in which the group should be displayed in a list of groups for a price sheet
groupType read-only	`string` enum custom prints canvas digitals products metals fine-art The slug name of the type of price sheet item group.
id read-only	`integer` The identifier for the price sheet group.
images	`price-sheet-element-image[]` Price Sheet Element Image An array of images which display the types of items which may be contained within the group.
isDefault read-only	`boolean` Denotes if the group is a default group. Default groups are created when the Price Sheet is created and cannot be deleted.
isFeaturedType	`boolean` Denotes that the group is meant to contain items which are to be featured in the price sheet.
isPackageType	`boolean` Denotes that the group is meant to contain packages.
isSecondary read-only	`boolean` Denotes if the group is a secondary copy of a default group. The secondary group can contain the same lab-fulfilled product available to the default group, as long as the product is not already contained in the default group.
labCatalogGroupId	`integer` The ID of the lab catalog group which was used to create the group.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name	`string` The name of the price sheet group.
priceSheetItems	`[]` Price Sheet Item An array containing the items which are part of the group.
priceSheetSubgroups	`price-sheet-subgroup[]` Price Sheet Subgroup An array containing the various subgroups of items within the group.
status read-only	`string` enum active deleted The current status of the price sheet group.
type	`string` enum price-sheet-group The type of object represented.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheetGroup"
        }
      }
    },
    "description": "The successfully updated Price Sheet Group."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Lists all subgroups for the price sheet group.

Returns a list of all subgroups for the price sheet group.

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group/{priceSheetGroupId}/subgroup

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetGroupId required	`integer` The pricesheet group identifier.
priceSheetId required	`integer` The price sheet identifier.

Header Parameters

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

Receiving the response

200
Schema

`200 OK`

Price sheet subgroup 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

price-sheet-subgroup[]

Price Sheet Subgroup

A collection of resources returned in the current result set.

Property	Description
bounds nullable read-only	`string` The dimensional bounds of the price sheet subgroup.
displayOrder	`integer` The order in which the subgroup should be displayed in a list of subgroups for a price sheet or price sheet group.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isCatchall deprecated	`boolean` Denotes that the subgroup contains items that are not intended to belong in a subgroup based by size or commonality. This property is only set when creating a new subgroup.
isCustom read-only	`boolean` Denotes if the Subgroup was created by the Studio.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name nullable	`string` The name of the price sheet subgroup.
type	`string` enum price-sheet-subgroup Type The type of resource represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

price-sheet-subgroup-collection

The type of resource represented.

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/PriceSheetSubgroupCollection"
        }
      }
    },
    "description": "Price sheet subgroup list response."
  }
}

Updates a batch of price sheet subgroups.

Updates the provided properties on each of the given subgroups in the collection.

patch

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group/{priceSheetGroupId}/subgroup

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetGroupId required	`integer` The pricesheet group identifier.
priceSheetId required	`integer` The price sheet identifier.

Header Parameters

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

Request Body

The collection of subgroups to update.

application/vnd.shootproof+json

Property Description

items

object[]

A collection of one or more batched resources. If items is null or an empty array, no action is taken.

Property	Description
displayOrder	`integer` The order in which the subgroup should be displayed in a list of subgroups for a price sheet or price sheet group.
id	`number[]` Identifies one or more resources for which changes may be applied. This property accepts several different types of values: `[]`: If the `id` property is an empty array, then the changes will apply to all resources applicable to the context of the operation. `number[]`: If the value is an array of integers, then the changes will apply to each of the resources identified by the numbers. If any of these numbers are negative (i.e., prefixed with a minus sign, `-`), the changes will not apply to resources identified by those numbers, even if the same number is present in the array in its positive form. `null` or not present: An undefined state. The changes will not be applied to any resources. This functionality allows a great degree of flexibility to batch processing of API resources. We can ask that the changes be applied to all resources for the given `type` by providing an empty array. We can apply the changes to all resources except a few (e.g., `"id": [-45, -76, -32]`). We can apply the changes to some resources, but not others (e.g., `"id": [-32, 56, 45, -6, 18, 32]`—in this example, the changes will not be applied to the resource identified by `32`).
name	`string` The name of the price sheet subgroup.
type	`string` The type of resource represented (i.e., `event`).

type

string

The model type for the collection object (i.e., event-collection).

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/PriceSheetSubgroupCollectionInPatch"
      }
    }
  },
  "description": "The collection of subgroups to update.",
  "required": true
}

Receiving the response

`200 OK`

Price sheet subgroup 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

price-sheet-subgroup[]

Price Sheet Subgroup

A collection of resources returned in the current result set.

Property	Description
bounds nullable read-only	`string` The dimensional bounds of the price sheet subgroup.
displayOrder	`integer` The order in which the subgroup should be displayed in a list of subgroups for a price sheet or price sheet group.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isCatchall deprecated	`boolean` Denotes that the subgroup contains items that are not intended to belong in a subgroup based by size or commonality. This property is only set when creating a new subgroup.
isCustom read-only	`boolean` Denotes if the Subgroup was created by the Studio.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name nullable	`string` The name of the price sheet subgroup.
type	`string` enum price-sheet-subgroup Type The type of resource represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

price-sheet-subgroup-collection

The type of resource represented.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheetSubgroupCollection"
        }
      }
    },
    "description": "Price sheet subgroup list response."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Create a price sheet subgroup

Creates a new price sheet subgroup object for the current studio.

post

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group/{priceSheetGroupId}/subgroup

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetGroupId required	`integer` The pricesheet group identifier.
priceSheetId required	`integer` The price sheet identifier.

Header Parameters

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

Request Body

application/vnd.shootproof+json

Property	Description
displayOrder	`integer` The order in which the subgroup should be displayed in a list of subgroups for a price sheet or price sheet group.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isCatchall deprecated	`boolean` Denotes that the subgroup contains items that are not intended to belong in a subgroup based by size or commonality. This property is only set when creating a new subgroup.
name nullable	`string` The name of the price sheet subgroup.
type	`string` enum price-sheet-subgroup 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/PriceSheetSubgroup"
      }
    }
  }
}

Receiving the response

`201 Created`

The successfully-created price sheet subgroup object.

Headers

Header	Description
Location	`string` uri The URL to the newly-created price sheet subgroup object.

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
bounds nullable read-only	`string` The dimensional bounds of the price sheet subgroup.
displayOrder	`integer` The order in which the subgroup should be displayed in a list of subgroups for a price sheet or price sheet group.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isCatchall deprecated	`boolean` Denotes that the subgroup contains items that are not intended to belong in a subgroup based by size or commonality. This property is only set when creating a new subgroup.
isCustom read-only	`boolean` Denotes if the Subgroup was created by the Studio.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name nullable	`string` The name of the price sheet subgroup.
type	`string` enum price-sheet-subgroup Type The type of resource represented.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

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

Removes a single price sheet subgroup object from the price sheet.

Removes the specified subgroup from the price sheet.

delete

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group/{priceSheetGroupId}/subgroup/{priceSheetSubgroupId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetGroupId required	`integer` The pricesheet group identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetSubgroupId required	`integer` The pricesheet subgroup identifier.

Header Parameters

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

Receiving the response

`204 No Content`

Successful deletion response.

`409 Conflict`

Subgroup containing items cannot be deleted.

OpenAPI Schema

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

{
  "204": {
    "description": "Successful deletion response."
  },
  "409": {
    "description": "Subgroup containing items cannot be deleted."
  }
}

Returns a single price sheet subgroup object by ID.

Returns a specific price sheet subgroup using the ID of the subgroup.

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group/{priceSheetGroupId}/subgroup/{priceSheetSubgroupId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetGroupId required	`integer` The pricesheet group identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetSubgroupId required	`integer` The pricesheet subgroup identifier.

Header Parameters

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

Receiving the response

`200 OK`

A price sheet subgroup object.

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
bounds nullable read-only	`string` The dimensional bounds of the price sheet subgroup.
displayOrder	`integer` The order in which the subgroup should be displayed in a list of subgroups for a price sheet or price sheet group.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isCatchall deprecated	`boolean` Denotes that the subgroup contains items that are not intended to belong in a subgroup based by size or commonality. This property is only set when creating a new subgroup.
isCustom read-only	`boolean` Denotes if the Subgroup was created by the Studio.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name nullable	`string` The name of the price sheet subgroup.
type	`string` enum price-sheet-subgroup Type The type of resource represented.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheetSubgroup"
        }
      }
    },
    "description": "A price sheet subgroup object."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially updates a specific price sheet subgroup object.

Updates the specified price sheet subgroup using the provided data with the specified properties being overwritten.

patch

/studio/brand/{brandId}/price-sheet/{priceSheetId}/group/{priceSheetGroupId}/subgroup/{priceSheetSubgroupId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetGroupId required	`integer` The pricesheet group identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetSubgroupId required	`integer` The pricesheet subgroup identifier.

Header Parameters

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

Request Body

application/vnd.shootproof+json

Property	Description
displayOrder	`integer` The order in which the subgroup should be displayed in a list of subgroups for a price sheet or price sheet group.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isCatchall deprecated	`boolean` Denotes that the subgroup contains items that are not intended to belong in a subgroup based by size or commonality. This property is only set when creating a new subgroup.
name nullable	`string` The name of the price sheet subgroup.
type	`string` enum price-sheet-subgroup 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": {
      "example": {
        "displayOrder": 4,
        "name": "A subgroup!",
        "type": "price-sheet-subgroup"
      },
      "schema": {
        "$ref": "#/components/schemas/PriceSheetSubgroup"
      }
    }
  }
}

Receiving the response

`200 OK`

The successfully-updated price sheet subgroup.

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
bounds nullable read-only	`string` The dimensional bounds of the price sheet subgroup.
displayOrder	`integer` The order in which the subgroup should be displayed in a list of subgroups for a price sheet or price sheet group.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isCatchall deprecated	`boolean` Denotes that the subgroup contains items that are not intended to belong in a subgroup based by size or commonality. This property is only set when creating a new subgroup.
isCustom read-only	`boolean` Denotes if the Subgroup was created by the Studio.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name nullable	`string` The name of the price sheet subgroup.
type	`string` enum price-sheet-subgroup Type The type of resource represented.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

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

Delete a batch of items on a price sheet

Using a batch operation, you can delete multiple events at once.

delete

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Request Body

The list of price sheet items to delete.

application/vnd.shootproof+json

Property	Description
items	`object[]` Price Sheet Item A collection of resources returned in the current result set.
type	`string` enum price-sheet-item-collection 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/PriceSheetItemCollection"
      }
    }
  },
  "description": "The list of price sheet items to delete.",
  "required": true
}

Receiving the response

`204 No Content`

The specified price sheet items were deleted.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

`409 Conflict`

The request could not be completed due to a conflict with the current state of the target resource.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "204": {
    "description": "The specified price sheet items were deleted."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "409": {
    "$ref": "#/components/responses/conflictError",
    "description": "One or more items in the batch could not be deleted."
  }
}

List items on a price sheet

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Query Parameters

Property	Description
filterPriceSheetGroupId	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier Group identifier by which to filter results.
filterPriceSheetSubgroupId	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier Subgroup identifier by which to filter results.

Header Parameters

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

Receiving the response

200
Schema

`200 OK`

A list of items on a price sheet.

Response Body

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

Properties

Property Description

items

object[]

Price Sheet Item

A collection of resources returned in the current result set.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

price-sheet-item-collection

The type of resource represented.

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/PriceSheetItemCollection"
        }
      }
    },
    "description": "A list of items on a price sheet."
  }
}

Update a batch of items on a price sheet

Using a batch operation, you can update multiple price sheet items at once.

patch

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Request Body

The list of price sheet items to update.

application/vnd.shootproof+json

Property	Description
items	`object[]` Price Sheet Item A collection of resources returned in the current result set.
type	`string` enum price-sheet-item-collection 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/PriceSheetItemCollection"
      }
    }
  },
  "description": "The list of price sheet items to update.",
  "required": true
}

Receiving the response

`200 OK`

A list of price sheet items.

Response Body

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

Properties

Property Description

items

object[]

Price Sheet Item

A collection of resources returned in the current result set.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

price-sheet-item-collection

The type of resource represented.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheetItemCollection"
        }
      }
    },
    "description": "A list of price sheet items."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Create an item on a price sheet

To create an item on a price sheet, post either a standard item, a digital item, a package containing standard or digital items, or a collection representation that may contain all three types.

If posting a collection, each item in the collection will result in a new item created on the price sheet; this can be a handy way to create a batch of price sheet items in a single request.

post

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Request Body

A standard price sheet item, a digital item, a package item, or a collection of price sheet items.

application/vnd.shootproof+json

either

price-sheet-item

price-sheet-item-digital

price-sheet-item-collection

List

price-sheet-item-package

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": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/PriceSheetItem"
          },
          {
            "$ref": "#/components/schemas/PriceSheetItemDigital"
          },
          {
            "$ref": "#/components/schemas/PriceSheetItemCollection"
          },
          {
            "$ref": "#/components/schemas/PriceSheetItemPackage"
          }
        ]
      }
    }
  },
  "description": "A standard price sheet item, a digital item, a package item, or a\ncollection of price sheet items.",
  "required": true
}

Receiving the response

`201 Created`

The new price sheet item or a list of price sheet items if a collection was submitted.

Headers

Header	Description
Location	`string` uri If a single price sheet item is returned, the `Location` header will be present and contain the URL to the new price sheet 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

either

price-sheet-item

price-sheet-item-digital

price-sheet-item-collection

List

price-sheet-item-package

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "201": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/PriceSheetItem"
            },
            {
              "$ref": "#/components/schemas/PriceSheetItemDigital"
            },
            {
              "$ref": "#/components/schemas/PriceSheetItemCollection"
            },
            {
              "$ref": "#/components/schemas/PriceSheetItemPackage"
            }
          ]
        }
      }
    },
    "description": "The new price sheet item or a list of price sheet items if a collection\nwas submitted.",
    "headers": {
      "Location": {
        "description": "If a single price sheet item is returned, the `Location` header will\nbe present and contain the URL to the new price sheet item.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Remove an item from a price sheet

delete

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item/{priceSheetItemId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetItemId required	`integer` The price sheet item identifier.

Header Parameters

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

Receiving the response

`204 No Content`

The resource was successfully deleted.

`409 Conflict`

The request could not be completed due to a conflict with the current state of the target resource.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "204": {
    "description": "The resource was successfully deleted."
  },
  "409": {
    "$ref": "#/components/responses/conflictError",
    "description": "Item could not be deleted."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Get an item from a price sheet

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item/{priceSheetItemId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetItemId required	`integer` The price sheet item identifier.

Header Parameters

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

Receiving the response

`200 OK`

A price sheet 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

either

price-sheet-item

price-sheet-item-digital

price-sheet-item-package

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/PriceSheetItem"
            },
            {
              "$ref": "#/components/schemas/PriceSheetItemDigital"
            },
            {
              "$ref": "#/components/schemas/PriceSheetItemPackage"
            }
          ]
        }
      }
    },
    "description": "A price sheet item."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially update an item on a price sheet

patch

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item/{priceSheetItemId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetItemId required	`integer` The price sheet item identifier.

Header Parameters

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

Request Body

The price sheet item to update. Only provide those properties that need updating.

application/vnd.shootproof+json

either

price-sheet-item

price-sheet-item-digital

price-sheet-item-package

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": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/PriceSheetItem"
          },
          {
            "$ref": "#/components/schemas/PriceSheetItemDigital"
          },
          {
            "$ref": "#/components/schemas/PriceSheetItemPackage"
          }
        ]
      }
    }
  },
  "description": "The price sheet item to update. Only provide those properties that need\nupdating.",
  "required": true
}

Receiving the response

`200 OK`

The updated price sheet 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

either

price-sheet-item

price-sheet-item-digital

price-sheet-item-package

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/PriceSheetItem"
            },
            {
              "$ref": "#/components/schemas/PriceSheetItemDigital"
            },
            {
              "$ref": "#/components/schemas/PriceSheetItemPackage"
            }
          ]
        }
      }
    },
    "description": "The updated price sheet item."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Update an item on a price sheet

put

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item/{priceSheetItemId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetItemId required	`integer` The price sheet item identifier.

Header Parameters

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

Request Body

The price sheet item to update.

application/vnd.shootproof+json

either

price-sheet-item

price-sheet-item-digital

price-sheet-item-package

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": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/PriceSheetItem"
          },
          {
            "$ref": "#/components/schemas/PriceSheetItemDigital"
          },
          {
            "$ref": "#/components/schemas/PriceSheetItemPackage"
          }
        ]
      }
    }
  },
  "description": "The price sheet item to update.",
  "required": true
}

Receiving the response

`200 OK`

The updated price sheet 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

either

price-sheet-item

price-sheet-item-digital

price-sheet-item-package

Price Sheet Element Image

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/PriceSheetItem"
            },
            {
              "$ref": "#/components/schemas/PriceSheetItemDigital"
            },
            {
              "$ref": "#/components/schemas/PriceSheetItemPackage"
            }
          ]
        }
      }
    },
    "description": "The updated price sheet item."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Remove a child item from a price sheet item

delete

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item/{priceSheetItemId}/child-item/{priceSheetChildItemId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetChildItemId required	`integer` The price sheet child item identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetItemId required	`integer` The price sheet item identifier.

Header Parameters

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

Receiving the response

`204 No Content`

The resource was successfully deleted.

`409 Conflict`

If attempting to delete the last child item for the item, then we respond with a 409 Conflict response.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "204": {
    "description": "The resource was successfully deleted."
  },
  "409": {
    "content": {
      "application/problem+json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    },
    "description": "If attempting to delete the last child item for the item, then we respond\nwith a `409 Conflict` response."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Updates a batch of price sheet item images.

Updates the provided properties on each of the given price sheet item images in the collection.

patch

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item/{priceSheetItemId}/image

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetItemId required	`integer` The price sheet item identifier.

Header Parameters

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

Request Body

The collection of price sheet items images to update.

application/vnd.shootproof+json

Property Description

items

price-sheet-element-image[]

A collection of one or more batched resources. If items is null or an empty array, no action is taken.

Property	Description
displayOrder	`integer` ≥ 0 ≤ 999 The order in which the image should be displayed in a list of other images for the related price sheet element.
id	`number[]` Identifies one or more resources for which changes may be applied. This property accepts several different types of values: `[]`: If the `id` property is an empty array, then the changes will apply to all resources applicable to the context of the operation. `number[]`: If the value is an array of integers, then the changes will apply to each of the resources identified by the numbers. If any of these numbers are negative (i.e., prefixed with a minus sign, `-`), the changes will not apply to resources identified by those numbers, even if the same number is present in the array in its positive form. `null` or not present: An undefined state. The changes will not be applied to any resources. This functionality allows a great degree of flexibility to batch processing of API resources. We can ask that the changes be applied to all resources for the given `type` by providing an empty array. We can apply the changes to all resources except a few (e.g., `"id": [-45, -76, -32]`). We can apply the changes to some resources, but not others (e.g., `"id": [-32, 56, 45, -6, 18, 32]`—in this example, the changes will not be applied to the resource identified by `32`).
type	`string` enum price-sheet-element-image The type of object represented.

type

string

The model type for the collection object (i.e., event-collection).

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/PriceSheetElementImageCollectionInPatch"
      }
    }
  },
  "description": "The collection of price sheet items images to update.",
  "required": true
}

Receiving the response

`200 OK`

Price Sheet Item Image 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

price-sheet-element-image[]

A collection of resources returned in the current result set.

Property	Description
created read-only	`string` date-time The creation date of the image.
displayOrder	`integer` ≥ 0 ≤ 999 The order in which the image should be displayed in a list of other images for the related price sheet element.
displayUrl nullable read-only	`object` Image Display Url Display URLs for this image.
filesize read-only	`integer` The original filesize of the image (in bytes).
height read-only	`integer` The height in pixels of the image.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
mimeType nullable read-only	`string` The image file MIME type.
name read-only	`string` ≤ 100 characters The original filename of the image.
type	`string` enum price-sheet-element-image The type of object represented.
width read-only	`integer` The width in pixels of the image.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

price-sheet-element-image-collection

Price Sheet Shipping Option

The type of resource represented.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheetElementImageCollection"
        }
      }
    },
    "description": "Price Sheet Item Image list response."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Creates a new price sheet item image object.

post

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item/{priceSheetItemId}/image

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetItemId required	`integer` The price sheet item identifier.

Header Parameters

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

Request Body

multipart/mixed

Property	Description
displayOrder	`integer` ≥ 0 ≤ 999 The order in which the image should be displayed in a list of other images for the related price sheet element.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
type	`string` enum price-sheet-element-image The type of object represented.

OpenAPI Schema

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

{
  "content": {
    "multipart/mixed": {
      "example": "--SP_BOUNDARY\nContent-Type: application/vnd.shootproof+json\n\n{\n    \"type\": \"price-sheet-element-image\",\n    \"displayOrder\": 1\n}\n\n--SP_BOUNDARY\nContent-Disposition: attachment; filename=image.jpg\nContent-Type: image/jpeg\n\n[binary data]\n\n--SP_BOUNDARY--",
      "schema": {
        "$ref": "#/components/schemas/PriceSheetElementImage"
      }
    }
  }
}

Receiving the response

`201 Created`

The successfully-created price sheet item image object.

Headers

Header	Description
Location	`string` uri The URL to the newly-created price sheet item image object.

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
created read-only	`string` date-time The creation date of the image.
displayOrder	`integer` ≥ 0 ≤ 999 The order in which the image should be displayed in a list of other images for the related price sheet element.
displayUrl nullable read-only	`object` Image Display Url Display URLs for this image.
filesize read-only	`integer` The original filesize of the image (in bytes).
height read-only	`integer` The height in pixels of the image.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
mimeType nullable read-only	`string` The image file MIME type.
name read-only	`string` ≤ 100 characters The original filename of the image.
type	`string` enum price-sheet-element-image The type of object represented.
width read-only	`integer` The width in pixels of the image.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

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

Removes a single price sheet item image object.

Deletes the price sheet item image object from the item.

delete

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item/{priceSheetItemId}/image/{priceSheetItemImageId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetItemId required	`integer` The price sheet item identifier.
priceSheetItemImageId required	`integer` The price sheet item image identifier.

Header Parameters

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

Receiving the response

204
Schema

`204 No Content`

Successful deletion response.

OpenAPI Schema

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

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

Returns a single price sheet item image object by ID.

Returns a specific price sheet item image using the ID of the image.

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item/{priceSheetItemId}/image/{priceSheetItemImageId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetItemId required	`integer` The price sheet item identifier.
priceSheetItemImageId required	`integer` The price sheet item image identifier.

Header Parameters

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

Receiving the response

`200 OK`

A price sheet item image object.

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
created read-only	`string` date-time The creation date of the image.
displayOrder	`integer` ≥ 0 ≤ 999 The order in which the image should be displayed in a list of other images for the related price sheet element.
displayUrl nullable read-only	`object` Image Display Url Display URLs for this image.
filesize read-only	`integer` The original filesize of the image (in bytes).
height read-only	`integer` The height in pixels of the image.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
mimeType nullable read-only	`string` The image file MIME type.
name read-only	`string` ≤ 100 characters The original filename of the image.
type	`string` enum price-sheet-element-image The type of object represented.
width read-only	`integer` The width in pixels of the image.

Error Response

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

Check out our errors guide for more information.

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

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

Forbidden Error Example

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

Not Found Error Example

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

Server Error Example

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

Unauthorized Error Example

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

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/PriceSheetElementImage"
        }
      }
    },
    "description": "A price sheet item image object."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially updates a specific price sheet item image object.

Updates the specified price sheet item image using the provided data with the specified properties being overwritten.

patch

/studio/brand/{brandId}/price-sheet/{priceSheetId}/item/{priceSheetItemId}/image/{priceSheetItemImageId}

Making the request

Example Request

Coming Soon

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

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
priceSheetId required	`integer` The price sheet identifier.
priceSheetItemId required	`integer` The price sheet item identifier.
priceSheetItemImageId required	`integer` The price sheet item image identifier.

Header Parameters

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

Request Body

application/vnd.shootproof+json

Property	Description
displayOrder	`integer` ≥ 0 ≤ 999 The order in which the image should be displayed in a list of other images for the related price sheet element.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
type	`string` enum price-sheet-element-image The type of object 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": {
      "example": {
        "displayOrder": 4,
        "type": "price-sheet-element-image"
      },
      "schema": {
        "$ref": "#/components/schemas/PriceSheetElementImage"
      }
    }
  }
}

Receiving the response

`200 OK`

The successfully-updated price sheet item image.

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
created read-only	`string` date-time The creation date of the image.
displayOrder	`integer` ≥ 0 ≤ 999 The order in which the image should be displayed in a list of other images for the related price sheet element.
displayUrl nullable read-only	`object` Image Display Url Display URLs for this image.
filesize read-only	`integer` The original filesize of the image (in bytes).
height read-only	`integer` The height in pixels of the image.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
mimeType nullable read-only	`string` The image file MIME type.
name read-only	`string` ≤ 100 characters The original filename of the image.
type	`string` enum price-sheet-element-image The type of object represented.
width read-only	`integer` The width in pixels of the image.

`400 Bad Request`

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

Response Body

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

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

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

Property Description

errors

object

reason

string

enum

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

An optional reason for the error response.

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

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

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

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

Lists all custom shipping options for the price sheet.

Returns a list of all Shipping Options for the Price Sheet.

get

/studio/brand/{brandId}/price-sheet/{priceSheetId}/shipping-option

Making the request

Example Request

Coming Soon

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

Path Parameters

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

Header Parameters

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

Receiving the response

200
Schema

`200 OK`

Price Sheet Shipping Option 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

price-sheet-shipping-option[]

A collection of resources returned in the current result set.

Property	Description
created read-only	`string` date-time The creation date of this shipping option.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only	`object` Links Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
price	`number` ≤ 9999.99 A decimal value of the price of the shipping option, represented in the currency of the brand.
title	`string` The title of the price sheet shipping option.
type	`string` enum price-sheet-shipping-option Type The type of resource represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

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

type

string

enum

price-sheet-shipping-option-collection