Price Sheet Shipping Option

Description

An option by which to ship items ordered from the price sheet.

Properties

Property Description
created read-only

The creation date of this shipping option.

id

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

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

price

A decimal value of the price of the shipping option, represented in the currency of the brand.

title

The title of the price sheet shipping option.

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.

{
  "description": "An option by which to ship items ordered from the price sheet.",
  "properties": {
    "created": {
      "description": "The creation date of this shipping option.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "price": {
      "description": "A decimal value of the price of the shipping option,\nrepresented in the currency of the brand.",
      "example": 6.45,
      "maximum": 9999.99,
      "type": "number"
    },
    "title": {
      "description": "The title of the price sheet shipping option.",
      "example": "Custom Shipping",
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "enum": [
            "price-sheet-shipping-option"
          ]
        },
        {
          "$ref": "#/components/schemas/Type"
        }
      ]
    }
  },
  "required": [
    "type",
    "title",
    "price"
  ],
  "title": "Price Sheet Shipping Option",
  "type": "object"
}