Beta Order

OpenAPI Schema

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

{
  "description": "An order object. Orders are created by customers when they complete a\npurchase checkout or by a studio user creating an order on behalf of a\ncustomer.",
  "properties": {
    "adjustment": {
      "description": "Amount of adjustment applied to this order. Positive number which is\nalways subtracted from subtotal. Derived from the sum of discount\namounts.",
      "nullable": true,
      "readOnly": true,
      "type": "number"
    },
    "balanceDue": {
      "description": "The amount of the balance presently due on this order. Should equal\nthe sum of grand total and adjustments minus payments. This is a\ncalculated property. @TODO: remove?",
      "readOnly": true,
      "type": "number"
    },
    "billingAddress": {
      "allOf": [
        {
          "nullable": true
        },
        {
          "$ref": "#/components/schemas/Address"
        }
      ],
      "description": "The billing address for this order."
    },
    "clientNote": {
      "description": "Client submitted note, added by the client/customer when the order\nwas placed.",
      "nullable": true,
      "type": "string"
    },
    "clientSelectedShippingId": {
      "description": "Shipping option that the client chose at checkout. This field is\nreadOnly in update requests.",
      "nullable": true,
      "type": "string"
    },
    "combinedOrder": {
      "description": "Indicates whether this order was created by combining multiple\norders.",
      "readOnly": true,
      "type": "boolean"
    },
    "created": {
      "description": "The creation date of this order.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "currencyCode": {
      "description": "Currency code for the currency all order amounts are expressed in.",
      "readOnly": true,
      "type": "string"
    },
    "currencySymbol": {
      "description": "Currency symbol of the currency all order amounts are expressed in.",
      "readOnly": true,
      "type": "string"
    },
    "customStatus": {
      "description": "A custom order status provided by the studio",
      "nullable": true,
      "type": "string"
    },
    "customerCropSelected": {
      "description": "Whether this order contains items having a customer defined crop.",
      "readOnly": true,
      "type": "boolean"
    },
    "customerEmail": {
      "description": "The email address of the customer having billing responsibility for\nthis order.",
      "format": "email",
      "type": "string"
    },
    "customerName": {
      "description": "The name of the customer having billing responsibility for this order.\nRead-only because it's a property of the customer's address, not the Order\nobject itself.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "customerPhone": {
      "description": "The phone number submitted with the order.",
      "nullable": true,
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "digitalDownloadDate": {
      "description": "**Important: this property returns mock data. See example**. The\ndate on which the digital order items were downloaded by the\ncustomer. Null if `fulfillmentType` does not contain `digital` or if\nthe digital items have not yet been downloaded.",
      "example": "null",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "digitalSentDate": {
      "description": "**Important: this property returns mock data. See example**. The\ndate on which the digital order items were sent to the customer.\nNull if `fulfillmentType` does not contain `digital` or if the\ndigital items are not yet sent.",
      "example": "2018-03-19T02:19:51+00:00",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "digitalStatus": {
      "description": "String slug representation of the current digital status of this\norder. Null if `fulfillmentType` does not contain `digital`.\n'awaiting-studio' = awaiting studio approval. 'awaiting-payment' =\nnot released because payment is incomplete. 'sent' = the download\nURL has been emailed to the customer.",
      "enum": [
        "awaiting-studio",
        "awaiting-payment",
        "sent"
      ],
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "eventId": {
      "deprecated": true,
      "description": "The identifier for the event this order originates from. This can\nonly be null if the order is part of a combined order. This field is\nread-only in update requests.",
      "nullable": true,
      "type": "integer"
    },
    "eventName": {
      "deprecated": true,
      "description": "The name of the event this order originates from.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "fulfillmentTypes": {
      "description": "Array of slugs descriptions of the order fulfillment types. An order\nmay have one or more fulfillment types. Determined by the items in\nthe order.",
      "items": {
        "enum": [
          "lab",
          "digital",
          "self"
        ],
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "grandTotal": {
      "description": "The order grand total value, in the currency selected by the order's\ncurrencyCode. Grand total is calculated by adding the item price for\neach item and item option, subtracting discounts and applying tax.\nGrand total is fixed to the time when order was placed by the\ncustomer.",
      "readOnly": true,
      "type": "number"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "isPaid": {
      "deprecated": true,
      "description": "The `isPaid` property is `true` if the order is fully paid or has been\nmarked as paid through the Studio Panel.\n\n*This property is deprecated and may be removed in the future.*",
      "readOnly": true,
      "type": "boolean"
    },
    "itemCount": {
      "description": "The number of items on this order.",
      "readOnly": true,
      "type": "number"
    },
    "labApprovedByStudioDate": {
      "description": "The date on which this order was approved for processing by lab.",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "labCatalogId": {
      "description": "Identifier of the lab catalog containing the items which comprise\nthis order. This field is readOnly in update requests.",
      "nullable": true,
      "type": "integer"
    },
    "labId": {
      "description": "The id of the lab fulfilling the order.",
      "nullable": true,
      "readOnly": true,
      "type": "number"
    },
    "labName": {
      "deprecated": true,
      "description": "*Deprecated.* Please use the `lab-catalog` link relation to obtain lab\ninformation related to this order.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "labReceipts": {
      "description": "Collection of records of lab receipts of orders.",
      "items": {
        "description": "A lab receipt object. Indicates lab receipt of order from studio.",
        "properties": {
          "id": {
            "description": "The record identifier for the receipt.",
            "readOnly": true,
            "type": "integer"
          },
          "labOrderNumber": {
            "description": "The order number created by the lab for processing this SP\norder.",
            "readOnly": true,
            "type": "string"
          },
          "receiptDate": {
            "description": "The date when this order was accepted by the lab, the receipt\ndate.",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "labShipments": {
      "description": "Lab shipments associated with this order",
      "items": {
        "description": "A lab shipment object.",
        "properties": {
          "created": {
            "description": "The creation date of this shipment record.",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
          },
          "id": {
            "description": "The record identifier for the shipment.",
            "readOnly": true,
            "type": "integer"
          },
          "labOrderNumber": {
            "description": "The order number created by the lab for processing this SP\norder.",
            "readOnly": true,
            "type": "string"
          },
          "labReference": {
            "description": "Text field used by lab to reference the unique identifier the\norder was submitted to the lab with. Optional reference value\nthat may be used by the lab.",
            "readOnly": true,
            "type": "string"
          },
          "shipDate": {
            "description": "The date when this shipment was reported as `shipped`.",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
          },
          "trackingId": {
            "description": "The shipment tracking ID, used for tracking the shipment.",
            "readOnly": true,
            "type": "string"
          },
          "trackingUrl": {
            "description": "The shipment tracking URL, used for tracking the shipment.",
            "readOnly": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "labStatus": {
      "description": "The slug string name of the current status of lab fulfilled orders.\nNull if order is studio-fulfilled. Alternately referred to as `lab\nprogress`. This is null for any order not having a `fulfillmentType`\ncontaining `lab`.",
      "enum": [
        "pending-copy-of-originals",
        "copying-originals",
        "pending-studio-confirmation",
        "submit-to-lab",
        "submitted-to-lab",
        "lab-received",
        "lab-completed",
        "canceled"
      ],
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "labSubmittedDate": {
      "description": "The date on which this order's lab fulfilled items were submitted to\nthe lab for fulfillment.",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "orderStatus": {
      "description": "The slug string name of the current status of this order. See\n`customStatus` for description of interaction with that field.\n@TODO: Determine whether the change history of lab statuses is\nrequired.",
      "enum": [
        "archived",
        "canceled",
        "completed",
        "deleted",
        "new",
        "on-hold",
        "pending",
        "printing",
        "shipped"
      ],
      "nullable": true,
      "type": "string"
    },
    "origin": {
      "description": "Indicates whether the order was placed by the studio or by their client.",
      "enum": [
        "client",
        "studio"
      ],
      "readOnly": true,
      "type": "string"
    },
    "parentOrderId": {
      "deprecated": true,
      "description": "*Deprecated.* Please use the `parent` link relation to obtain parent order\ninformation related to this order.",
      "nullable": true,
      "readOnly": true,
      "type": "number"
    },
    "paymentStatus": {
      "description": "The slug string name of the current payment status of this order.\nWhen the Order contains payments having a sum of not more than $0,\nthe `paymentStatus` is `unpaid`. When the sum of an order's payments\nare less than the order's `grandTotal`, the `paymentStatus` is\n'partially-paid'. When the sum of all order payments equals (or\nexceeds) the order's `grandTotal`, the `paymentStatus` is 'paid'.",
      "enum": [
        "unpaid",
        "partially-paid",
        "paid"
      ],
      "readOnly": true,
      "type": "string"
    },
    "pickupAtStudio": {
      "description": "Flag indicating whether the order will be picked up at the studio in\nlieu of being shipped. Applies to self fulfilled items or items drop\nshipped from lab to studio.",
      "type": "boolean"
    },
    "profitReleaseDate": {
      "description": "The date and time when order funds were released to the studio. Null\nif not applicable.",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "profitReleased": {
      "description": "Flag indicating whether the order's profit has been released. Funds\nare released to studio after 5 days, at which point this will be\ntrue. Null if not applicable, only applicable when payment gateway\nis ShootProof Payments.",
      "readOnly": true,
      "type": "boolean"
    },
    "retouchRequested": {
      "description": "Indicates whether the customer has requested retouching on the order.",
      "nullable": true,
      "readOnly": true,
      "type": "boolean",
      "x-beta": true,
      "x-internal": true
    },
    "roesOrderId": {
      "description": "The identifier for the order as recognized by ROES, if applicable.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "salesTax": {
      "description": "Amount of sales tax applied to this order.",
      "readOnly": true,
      "type": "number"
    },
    "salesTaxOnDigitals": {
      "description": "Flag indicating whether or not sales tax is applied to digital\ndownload items in this order. As indicated on the price sheet at the\ntime the order was placed.",
      "readOnly": true,
      "type": "boolean"
    },
    "salesTaxOnShipping": {
      "description": "Flag indicating whether or not sales tax is applied to the shipping\namount. As indicated on the price sheet at the time the order was\nplaced.",
      "readOnly": true,
      "type": "boolean"
    },
    "salesTaxPercent": {
      "description": "The percentage used to calculate sales tax amount.",
      "readOnly": true,
      "type": "number"
    },
    "salesTaxStateId": {
      "description": "The 2 character code identifying the US state for which sales tax is\nbeing applied.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "salesTaxTitle": {
      "description": "The human readable string labeling the sales tax amount. This is the\nsales tax label in use on the price sheet at the time the order was\nplaced.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "shippingAddress": {
      "allOf": [
        {
          "nullable": true
        },
        {
          "$ref": "#/components/schemas/Address"
        }
      ],
      "description": "The address this order should be shipped to."
    },
    "shippingCharge": {
      "description": "Amount charged by the studio to the customer for shipping of this\norder.",
      "type": "number"
    },
    "studioNote": {
      "description": "Studio submitted note, added by the studio owner/user when updating\nan order.",
      "nullable": true,
      "type": "string"
    },
    "tags": {
      "description": "Tags describing this order.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "description": "The model type for the response object.",
      "enum": [
        "order"
      ],
      "type": "string"
    },
    "vatNumber": {
      "description": "VAT number from the price sheet at the time the order was placed.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "vatTotal": {
      "description": "The amount of VAT calculated for and applied to this order.",
      "readOnly": true,
      "type": "number"
    }
  },
  "required": [
    "type",
    "brandId",
    "eventId",
    "customerEmail",
    "labCatalogId",
    "shippingAddress",
    "billingAddress"
  ],
  "title": "Order",
  "type": "object",
  "x-beta": true
}