Price Sheet Shipping Option Collection

Description

A collection of Price Sheet Shipping Options

Properties

Property Description
items

A collection of resources returned in the current result set.

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.

links required read-only

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

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

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

totalItems

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

totalPages

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

type

The type of resource represented.

OpenAPI Schema

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

{
  "description": "A collection of Price Sheet Shipping Options",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "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"
      },
      "title": "Price Sheet Shipping Option",
      "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": [
        "price-sheet-shipping-option-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection",
  "type": "object"
}