An option by which to ship products ordered from the lab catalog.
| Property | Description | ||||||
|---|---|---|---|---|---|---|---|
| citiesAvailable nullable |
An array of destination cities or localities where this shipping option is available. Applicable to couriers. |
||||||
| countryCode nullable |
Two-character ISO-3166 code identifying the destination country where this shipping option is available. |
||||||
| description nullable |
Display text shown to the user in order to give them information concerning the shipping option. |
||||||
| hasTracking |
Is tracking available for this method? |
||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||
| labShippingCode |
Code used by the lab to identify this shipping option. |
||||||
| 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. |
||||||
| maximumLabCost |
A decimal value of the maximum lab cost available to utilize this shipping option, converted to the currency of the brand. |
||||||
| maximumProductSize required nullable |
An object that specifies the maximum product size for this shipping option in inches.
|
||||||
| minimumLabCost |
A decimal value of the minimum lab cost required to utilize this shipping option, converted to the currency of the brand. |
||||||
| name |
The name of the lab catalog shipping option. |
||||||
| printsOnly |
Is this option available only for prints? Applicable to postal services with package size/weight limits. |
||||||
| retailPrice |
A decimal value of the retail price of the shipping option, converted to the currency of the brand. |
||||||
| transitDays |
General description of number of transit days. |
||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "An option by which to ship products ordered from the lab catalog.",
"properties": {
"citiesAvailable": {
"description": "An array of destination cities or localities where this shipping option is\navailable. Applicable to couriers.",
"items": {
"description": "Names of cities or localities where this shipping option is available",
"type": "string"
},
"nullable": true,
"type": "array"
},
"countryCode": {
"description": "Two-character ISO-3166 code identifying the destination country where this\nshipping option is available.",
"example": "UK",
"nullable": true,
"type": "string"
},
"description": {
"description": "Display text shown to the user in order to give them information\nconcerning the shipping option.",
"example": "16x20 and larger",
"nullable": true,
"type": "string"
},
"hasTracking": {
"description": "Is tracking available for this method?",
"example": true,
"type": "boolean"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"labShippingCode": {
"description": "Code used by the lab to identify this shipping option.",
"example": "USPS First LTR_DS_TP",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"maximumLabCost": {
"description": "A decimal value of the maximum lab cost available to utilize this shipping\noption, converted to the currency of the brand.",
"example": 9999.99,
"type": "number"
},
"maximumProductSize": {
"description": "An object that specifies the maximum product size for this shipping option in inches.",
"nullable": true,
"properties": {
"height": {
"description": "The number of inches of maximum height.",
"example": 12,
"type": "number"
},
"width": {
"description": "The number of inches of maximum width.",
"example": 8,
"type": "number"
}
},
"required": [
"width",
"height"
],
"type": "object"
},
"minimumLabCost": {
"description": "A decimal value of the minimum lab cost required to utilize this shipping\noption, converted to the currency of the brand.",
"example": 15.01,
"type": "number"
},
"name": {
"description": "The name of the lab catalog shipping option.",
"example": "APC International",
"type": "string"
},
"printsOnly": {
"description": "Is this option available only for prints? Applicable to postal services\nwith package size/weight limits.",
"example": false,
"type": "boolean"
},
"retailPrice": {
"description": "A decimal value of the retail price of the shipping option,\nconverted to the currency of the brand.",
"example": 6.45,
"type": "number"
},
"transitDays": {
"description": "General description of number of transit days.",
"example": "2-5 Days",
"type": "string"
},
"type": {
"allOf": [
{
"enum": [
"lab-catalog-shipping-option"
]
},
{
"$ref": "#/components/schemas/Type"
}
]
}
},
"title": "Lab Catalog Shipping Option",
"type": "object"
}