Brand Collection

OpenAPI Schema

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

{
  "description": "A collection (or list) of resources.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "A brand.",
        "properties": {
          "address": {
            "allOf": [
              {
                "description": "The mailing address for this brand.",
                "nullable": true
              },
              {
                "$ref": "#/components/schemas/Address"
              }
            ]
          },
          "automationSendHour": {
            "description": "The hour during which email automations for this brand will be sent, relative to the brand's time zone.",
            "maximum": 23,
            "minimum": 0,
            "type": "integer"
          },
          "created": {
            "description": "The creation date of this brand.",
            "format": "date-time",
            "type": "string"
          },
          "customDomain": {
            "description": "A custom domain for this brand, if applicable.",
            "format": "hostname",
            "nullable": true,
            "type": "string"
          },
          "email": {
            "description": "The email address for this brand.",
            "format": "email",
            "type": "string"
          },
          "facebookFanPageUrl": {
            "description": "The URL for this brand's Facebook fan page.",
            "format": "uri",
            "nullable": true,
            "type": "string"
          },
          "galleryDomain": {
            "description": "The domain for this brand's galleries.",
            "format": "uri",
            "type": "string"
          },
          "homepageBrandTheme": {
            "$ref": "#/components/schemas/BrandTheme"
          },
          "homepageBrandThemeId": {
            "description": "The identifier for this brand's homepage brand theme.",
            "type": "integer"
          },
          "id": {
            "description": "The identifier for this brand.",
            "type": "integer"
          },
          "instagramUsername": {
            "description": "The Instagram username for this brand.",
            "nullable": true,
            "type": "string"
          },
          "isDefault": {
            "description": "Whether this is the default brand for the logged-in user's studio.",
            "type": "boolean"
          },
          "labCatalogs": {
            "description": "An array of lab catalogs to which this brand has access.",
            "items": {
              "$ref": "#/components/schemas/LabCatalog"
            },
            "title": "Lab Catalog",
            "type": "array"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "locale": {
            "description": "The locale defined for this brand.",
            "type": "string"
          },
          "name": {
            "description": "The name of this brand.",
            "type": "string"
          },
          "phone": {
            "description": "The phone number for this brand.",
            "type": "string"
          },
          "subdomain": {
            "description": "The ShootProof subdomain for this brand.",
            "type": "string"
          },
          "taxIdentifier": {
            "description": "The tax ID defined for this brand.",
            "nullable": true,
            "type": "string"
          },
          "taxMethod": {
            "description": "The tax method for this brand.",
            "enum": [
              "exclusive",
              "inclusive"
            ],
            "nullable": true,
            "type": "string"
          },
          "twitterHandle": {
            "description": "The Twitter username for this brand.",
            "nullable": true,
            "type": "string"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Type"
              },
              {
                "enum": [
                  "brand"
                ]
              }
            ]
          },
          "useDefaultWatermark": {
            "description": "Whether or not the Brand's default watermark should be applied at\nupload time.",
            "type": "boolean"
          },
          "website": {
            "description": "The URL for this brand's website.",
            "format": "uri",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "Brand",
        "type": "object"
      },
      "title": "Brand",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "brand-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection",
  "type": "object"
}