changedOutput schema / oneOf
Previous value: -[
- {
- "additionalProperties": false,
- "properties": {
- "affiliateDisclosure": {
- "description": "The commission disclosure that applies to affiliate links.",
- "type": "string"
- },
- "alternatives": {
- "description": "Similar products compared alongside, kept separate from the same product's suppliers.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "offer": {
- "additionalProperties": false,
- "description": "The offer this supplier's row shows.",
- "properties": {
- "actionUrl": {
- "description": "The main link out to this offer: the supplier's product page, or its sign-up page when the affiliate programme pays only for sign-ups.",
- "format": "uri",
- "type": "string"
- },
- "affiliate": {
- "description": "Whether actionUrl earns a commission; it never changes prices or rankings.",
- "type": "boolean"
- },
- "available": {
- "description": "The supplier sells this configuration and quotes it for the destination.",
- "type": "boolean"
- },
- "buyerImportWarning": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "A charge the buyer may pay on import, in words; null when there is none."
- },
- "cheapest": {
- "description": "Has the lowest product plus shipping total among comparable offers; false when the comparison cannot rank suppliers.",
- "type": "boolean"
- },
- "checkedAt": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "When this price was last checked, as an ISO date-time; null when unknown."
- },
- "comparable": {
- "description": "The priced configuration matches the requested choice closely enough to compare.",
- "type": "boolean"
- },
- "criticalDifferences": {
- "description": "Ways this product differs from the one asked about; empty for the same product.",
- "items": {
- "minLength": 1,
- "type": "string"
- },
- "type": "array"
- },
- "currency": {
- "anyOf": [
- {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The currency these amounts are in; null when no price is known."
- },
- "delivered": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Product plus shipping in the response currency; null when the supplier cannot price it, never 0."
- },
- "deliveryDaysMax": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's longest stated delivery time, in days from order to arrival; null when unknown."
- },
- "deliveryDaysMin": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's shortest stated delivery time, in days from order to arrival; null when unknown."
- },
- "differencesUnresolved": {
- "anyOf": [
- {
- "minLength": 1,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "A difference that could not be confirmed; null when everything is known."
- },
- "duty": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Supplier-billed duty in the response currency, separate from the delivered total; 0 when the supplier bills none, null when unverified."
- },
- "dutyEstimate": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "converted": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "currency": {
- "description": "The currency of these duty amounts.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "max": {
- "description": "Highest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- },
- "min": {
- "description": "Lowest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- }
- },
- "required": [
- "min",
- "max",
- "currency"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The same estimate in the response currency; null when it could not be converted."
- },
- "native": {
- "additionalProperties": false,
- "description": "The duty estimate in the supplier's own currency.",
- "properties": {
- "basis": {
- "const": "line_net_x_compatible_product_rate",
- "description": "How the estimate was derived: the line's net price times the supplier's per-product duty rate.",
- "type": "string"
- },
- "currency": {
- "description": "The currency of these duty amounts.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "max": {
- "description": "Highest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- },
- "min": {
- "description": "Lowest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- }
- },
- "required": [
- "min",
- "max",
- "currency",
- "basis"
- ],
- "type": "object"
- }
- },
- "required": [
- "native",
- "converted"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The bounded duty estimate when only a range is known; absent otherwise."
- },
- "dutyOutcome": {
- "anyOf": [
- {
- "enum": [
- "charged",
- "not_applicable",
- "estimated",
- "unknown"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "charged when the supplier bills duty, not_applicable when none applies, estimated when only a range is known, unknown when unverified."
- },
- "dutySource": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The supplier's own duty amount, in its own currency.",
- "minimum": 0,
- "type": "number"
- },
- "currency": {
- "description": "The currency the supplier states that duty in.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- }
- },
- "required": [
- "amount",
- "currency"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's own duty charge as it states it; null when none is published."
- },
- "facts": {
- "description": "Labelled facts about this offer, such as print method, size range and quantity.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "label": {
- "description": "What the fact is about.",
- "type": "string"
- },
- "value": {
- "description": "The fact's value.",
- "type": "string"
- }
- },
- "required": [
- "label",
- "value"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "isYourSupplier": {
- "description": "The supplier the seller said they use today.",
- "type": "boolean"
- },
- "mostKept": {
- "description": "Leaves the seller the most per sale; false unless profit is shown and every supplier-billed duty is known.",
- "type": "boolean"
- },
- "note": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "How this offer's configuration differs from the one asked about, in words; null when there is nothing to add."
- },
- "price": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Product cost in the response currency, before shipping; null when unknown, never 0."
- },
- "priceBasis": {
- "const": "product-and-shipping",
- "description": "What the delivered total covers: product and shipping.",
- "type": "string"
- },
- "pricingBasis": {
- "description": "The selected price basis and any setup disclosure, in words.",
- "type": "string"
- },
- "pricingContext": {
- "additionalProperties": false,
- "description": "Present when this price only holds under stated conditions, such as a design the seller already has.",
- "properties": {
- "basis": {
- "description": "What the price assumes: an existing design the seller already has, or included digitisation.",
- "enum": [
- "existing-supplier-digitised-design",
- "digitisation-included"
- ],
- "type": "string"
- },
- "newDesignSetup": {
- "description": "How a new design's setup is charged, or that it is included.",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "applicability": {
- "description": "design-dependent when the fee depends on the artwork, selected when one fee applies to this order.",
- "enum": [
- "design-dependent",
- "selected"
- ],
- "type": "string"
- },
- "application": {
- "const": "not-modelled",
- "description": "Always not-modelled: the charge is disclosed but never added to a total.",
- "type": "string"
- },
- "fees": {
- "description": "The setup fees the supplier lists.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The fee amount in its own currency.",
- "minimum": 0,
- "type": "number"
- },
- "conditions": {
- "description": "What must hold for this fee to apply.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "currency": {
- "description": "Original supplier currency; never converted along with the unit price.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "kind": {
- "description": "What the fee is for: standard, text-only, image, adjustment, back-or-side or setup.",
- "enum": [
- "standard",
- "text-only",
- "image",
- "adjustment",
- "back-or-side",
- "setup"
- ],
- "type": "string"
- },
- "scope": {
- "description": "What the fee applies to: per design, per design and area, per order, per unit or unknown.",
- "enum": [
- "per-design",
- "per-design-and-area",
- "per-order",
- "per-unit",
- "unknown"
- ],
- "type": "string"
- },
- "source": {
- "description": "What the supplier states about this fee.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "taxBasis": {
- "description": "Whether the fee is quoted before VAT (ex-vat) or unclear.",
- "enum": [
- "ex-vat",
- "unknown"
- ],
- "type": "string"
- }
- },
- "required": [
- "kind",
- "amount",
- "currency",
- "taxBasis",
- "scope",
- "source",
- "conditions"
- ],
- "type": "object"
- },
- "maxItems": 8,
- "minItems": 1,
- "type": "array"
- },
- "includedInDeliveredTotal": {
- "const": false,
- "description": "Always false: setup charges stay outside the delivered total.",
- "type": "boolean"
- },
- "status": {
- "const": "listed",
- "description": "The supplier lists a setup charge.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "fees",
- "applicability",
- "application",
- "includedInDeliveredTotal"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "conditions": {
- "description": "What must hold for the inclusion.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "source": {
- "description": "What the supplier states about the inclusion.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "status": {
- "const": "included",
- "description": "Digitisation is included, so there is no setup charge.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "source",
- "conditions"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "reason": {
- "description": "Why the setup charge is unknown.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "source": {
- "description": "What the supplier states, when it says anything.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "status": {
- "const": "unknown",
- "description": "Whether a setup charge applies could not be established.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "reason"
- ],
- "type": "object"
- }
- ]
- },
- "physicalSelections": {
- "description": "The supplier options this price was quoted for.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "axisId": {
- "description": "The option field's id, such as size.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "axisLabel": {
- "description": "The option field as shown, such as Size.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "kind": {
- "description": "sku-option changes the unit price; standard-configuration is a fixed default.",
- "enum": [
- "sku-option",
- "standard-configuration"
- ],
- "type": "string"
- },
- "valueId": {
- "description": "The chosen value's id.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "valueLabel": {
- "description": "The chosen value as shown, such as Adult M.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "kind",
- "axisId",
- "valueId",
- "axisLabel",
- "valueLabel"
- ],
- "type": "object"
- },
- "maxItems": 8,
- "type": "array"
- },
- "policyId": {
- "description": "Which pricing policy this context follows.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "policyVersion": {
- "description": "The version of that pricing policy.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "recurringConditions": {
- "description": "What must remain true for this recurring unit price.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "source": {
- "description": "What the supplier states about this price, in its own words.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "basis",
- "policyId",
- "policyVersion",
- "source",
- "recurringConditions",
- "newDesignSetup",
- "physicalSelections"
- ],
- "type": "object"
- },
- "pricingPlan": {
- "description": "The supplier plan this price uses, such as Standard pricing.",
- "type": "string"
- },
- "product": {
- "description": "The supplier's own name for the product.",
- "type": "string"
- },
- "productUrl": {
- "description": "The supplier's page for this product and configuration.",
- "format": "uri",
- "type": "string"
- },
- "profit": {
- "anyOf": [
- {
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "dutyStatus": {
- "description": "How well the supplier-billed duty is established: known, estimated from bounded quotes, or unknown.",
- "enum": [
- "known",
- "estimated",
- "unknown"
- ],
- "type": "string"
- },
- "estimatedDutyDeducted": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The estimated duty deducted from the sale; null when duty is known or was not deducted."
- },
- "feeBreakdown": {
- "description": "Each platform fee and its amount.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The fee amount in the response currency.",
- "type": "number"
- },
- "label": {
- "description": "The fee's name, such as transaction fee.",
- "type": "string"
- }
- },
- "required": [
- "label",
- "amount"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "fees": {
- "description": "Platform fees for this sale in the response currency.",
- "type": "number"
- },
- "keep": {
- "description": "What the seller keeps per sale before tax, in the response currency.",
- "type": "number"
- },
- "margin": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Share of the sale the seller keeps, 0 to 1; null when the sale is zero."
- },
- "qualification": {
- "description": "In words, whether supplier-billed duty is included in or left out of this profit.",
- "type": "string"
- },
- "sale": {
- "description": "The selling price in the response currency; with targetMargin, the price to charge.",
- "type": "number"
- },
- "status": {
- "const": "calculated",
- "description": "Profit could be worked out for this offer.",
- "type": "string"
- },
- "supplierCost": {
- "description": "What the supplier charges in the response currency: product, shipping and any known duty.",
- "type": "number"
- }
- },
- "required": [
- "status",
- "dutyStatus",
- "qualification",
- "sale",
- "supplierCost",
- "fees",
- "feeBreakdown",
- "keep",
- "margin"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "reason": {
- "description": "Why: the supplier cost is unknown, the platform fees are unavailable, or the target margin cannot be reached.",
- "enum": [
- "missing_cost",
- "fees_unavailable",
- "target_not_reachable"
- ],
- "type": "string"
- },
- "status": {
- "const": "unavailable",
- "description": "Profit could not be worked out for this offer.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "reason"
- ],
- "type": "object"
- }
- ]
- },
- {
- "type": "null"
- }
- ],
- "description": "This offer's profit when a selling price or target margin was given; null otherwise."
- },
- "provider": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The print provider that makes the order, for a marketplace; null for a direct supplier."
- },
- "shipping": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Shipping cost in the response currency; null when unknown, never 0."
- },
- "sourceCurrency": {
- "anyOf": [
- {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The currency the supplier quoted its price in, before conversion to the response currency; null when no quote exists."
- },
- "supplier": {
- "description": "The supplier's name.",
- "type": "string"
- },
- "supplierId": {
- "description": "The supplier's id.",
- "type": "string"
- },
- "taxNote": {
- "description": "How VAT or sales tax applies to this price, in words.",
- "type": "string"
- },
- "versusYours": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Per sale against the seller's own supplier: positive means the seller keeps more here. Uses profit when shown, otherwise the delivered total; null when the two cannot be compared."
- }
- },
- "required": [
- "supplierId",
- "supplier",
- "provider",
- "product",
- "price",
- "shipping",
- "duty",
- "priceBasis",
- "delivered",
- "currency",
- "available",
- "comparable",
- "cheapest",
- "mostKept",
- "isYourSupplier",
- "profit",
- "versusYours",
- "note",
- "criticalDifferences",
- "differencesUnresolved",
- "pricingPlan",
- "deliveryDaysMin",
- "deliveryDaysMax",
- "checkedAt",
- "actionUrl",
- "productUrl",
- "affiliate",
- "facts"
- ],
- "type": "object"
- },
- "otherOfferCount": {
- "description": "How many other offers this supplier has, including any beyond otherOffers.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "otherOffers": {
- "description": "This supplier's other products and print providers for the choice.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "actionUrl": {
- "description": "The main link out to this offer: the supplier's product page, or its sign-up page when the affiliate programme pays only for sign-ups.",
- "format": "uri",
- "type": "string"
- },
- "affiliate": {
- "description": "Whether actionUrl earns a commission; it never changes prices or rankings.",
- "type": "boolean"
- },
- "available": {
- "description": "The supplier sells this configuration and quotes it for the destination.",
- "type": "boolean"
- },
- "buyerImportWarning": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "A charge the buyer may pay on import, in words; null when there is none."
- },
- "cheapest": {
- "description": "Has the lowest product plus shipping total among comparable offers; false when the comparison cannot rank suppliers.",
- "type": "boolean"
- },
- "checkedAt": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "When this price was last checked, as an ISO date-time; null when unknown."
- },
- "comparable": {
- "description": "The priced configuration matches the requested choice closely enough to compare.",
- "type": "boolean"
- },
- "criticalDifferences": {
- "description": "Ways this product differs from the one asked about; empty for the same product.",
- "items": {
- "minLength": 1,
- "type": "string"
- },
- "type": "array"
- },
- "currency": {
- "anyOf": [
- {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The currency these amounts are in; null when no price is known."
- },
- "delivered": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Product plus shipping in the response currency; null when the supplier cannot price it, never 0."
- },
- "deliveryDaysMax": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's longest stated delivery time, in days from order to arrival; null when unknown."
- },
- "deliveryDaysMin": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's shortest stated delivery time, in days from order to arrival; null when unknown."
- },
- "differencesUnresolved": {
- "anyOf": [
- {
- "minLength": 1,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "A difference that could not be confirmed; null when everything is known."
- },
- "duty": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Supplier-billed duty in the response currency, separate from the delivered total; 0 when the supplier bills none, null when unverified."
- },
- "dutyEstimate": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "converted": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "currency": {
- "description": "The currency of these duty amounts.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "max": {
- "description": "Highest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- },
- "min": {
- "description": "Lowest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- }
- },
- "required": [
- "min",
- "max",
- "currency"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The same estimate in the response currency; null when it could not be converted."
- },
- "native": {
- "additionalProperties": false,
- "description": "The duty estimate in the supplier's own currency.",
- "properties": {
- "basis": {
- "const": "line_net_x_compatible_product_rate",
- "description": "How the estimate was derived: the line's net price times the supplier's per-product duty rate.",
- "type": "string"
- },
- "currency": {
- "description": "The currency of these duty amounts.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "max": {
- "description": "Highest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- },
- "min": {
- "description": "Lowest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- }
- },
- "required": [
- "min",
- "max",
- "currency",
- "basis"
- ],
- "type": "object"
- }
- },
- "required": [
- "native",
- "converted"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The bounded duty estimate when only a range is known; absent otherwise."
- },
- "dutyOutcome": {
- "anyOf": [
- {
- "enum": [
- "charged",
- "not_applicable",
- "estimated",
- "unknown"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "charged when the supplier bills duty, not_applicable when none applies, estimated when only a range is known, unknown when unverified."
- },
- "dutySource": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The supplier's own duty amount, in its own currency.",
- "minimum": 0,
- "type": "number"
- },
- "currency": {
- "description": "The currency the supplier states that duty in.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- }
- },
- "required": [
- "amount",
- "currency"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's own duty charge as it states it; null when none is published."
- },
- "facts": {
- "description": "Labelled facts about this offer, such as print method, size range and quantity.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "label": {
- "description": "What the fact is about.",
- "type": "string"
- },
- "value": {
- "description": "The fact's value.",
- "type": "string"
- }
- },
- "required": [
- "label",
- "value"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "isYourSupplier": {
- "description": "The supplier the seller said they use today.",
- "type": "boolean"
- },
- "mostKept": {
- "description": "Leaves the seller the most per sale; false unless profit is shown and every supplier-billed duty is known.",
- "type": "boolean"
- },
- "note": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "How this offer's configuration differs from the one asked about, in words; null when there is nothing to add."
- },
- "price": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Product cost in the response currency, before shipping; null when unknown, never 0."
- },
- "priceBasis": {
- "const": "product-and-shipping",
- "description": "What the delivered total covers: product and shipping.",
- "type": "string"
- },
- "pricingBasis": {
- "description": "The selected price basis and any setup disclosure, in words.",
- "type": "string"
- },
- "pricingContext": {
- "additionalProperties": false,
- "description": "Present when this price only holds under stated conditions, such as a design the seller already has.",
- "properties": {
- "basis": {
- "description": "What the price assumes: an existing design the seller already has, or included digitisation.",
- "enum": [
- "existing-supplier-digitised-design",
- "digitisation-included"
- ],
- "type": "string"
- },
- "newDesignSetup": {
- "description": "How a new design's setup is charged, or that it is included.",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "applicability": {
- "description": "design-dependent when the fee depends on the artwork, selected when one fee applies to this order.",
- "enum": [
- "design-dependent",
- "selected"
- ],
- "type": "string"
- },
- "application": {
- "const": "not-modelled",
- "description": "Always not-modelled: the charge is disclosed but never added to a total.",
- "type": "string"
- },
- "fees": {
- "description": "The setup fees the supplier lists.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The fee amount in its own currency.",
- "minimum": 0,
- "type": "number"
- },
- "conditions": {
- "description": "What must hold for this fee to apply.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "currency": {
- "description": "Original supplier currency; never converted along with the unit price.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "kind": {
- "description": "What the fee is for: standard, text-only, image, adjustment, back-or-side or setup.",
- "enum": [
- "standard",
- "text-only",
- "image",
- "adjustment",
- "back-or-side",
- "setup"
- ],
- "type": "string"
- },
- "scope": {
- "description": "What the fee applies to: per design, per design and area, per order, per unit or unknown.",
- "enum": [
- "per-design",
- "per-design-and-area",
- "per-order",
- "per-unit",
- "unknown"
- ],
- "type": "string"
- },
- "source": {
- "description": "What the supplier states about this fee.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "taxBasis": {
- "description": "Whether the fee is quoted before VAT (ex-vat) or unclear.",
- "enum": [
- "ex-vat",
- "unknown"
- ],
- "type": "string"
- }
- },
- "required": [
- "kind",
- "amount",
- "currency",
- "taxBasis",
- "scope",
- "source",
- "conditions"
- ],
- "type": "object"
- },
- "maxItems": 8,
- "minItems": 1,
- "type": "array"
- },
- "includedInDeliveredTotal": {
- "const": false,
- "description": "Always false: setup charges stay outside the delivered total.",
- "type": "boolean"
- },
- "status": {
- "const": "listed",
- "description": "The supplier lists a setup charge.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "fees",
- "applicability",
- "application",
- "includedInDeliveredTotal"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "conditions": {
- "description": "What must hold for the inclusion.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "source": {
- "description": "What the supplier states about the inclusion.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "status": {
- "const": "included",
- "description": "Digitisation is included, so there is no setup charge.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "source",
- "conditions"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "reason": {
- "description": "Why the setup charge is unknown.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "source": {
- "description": "What the supplier states, when it says anything.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "status": {
- "const": "unknown",
- "description": "Whether a setup charge applies could not be established.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "reason"
- ],
- "type": "object"
- }
- ]
- },
- "physicalSelections": {
- "description": "The supplier options this price was quoted for.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "axisId": {
- "description": "The option field's id, such as size.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "axisLabel": {
- "description": "The option field as shown, such as Size.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "kind": {
- "description": "sku-option changes the unit price; standard-configuration is a fixed default.",
- "enum": [
- "sku-option",
- "standard-configuration"
- ],
- "type": "string"
- },
- "valueId": {
- "description": "The chosen value's id.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "valueLabel": {
- "description": "The chosen value as shown, such as Adult M.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "kind",
- "axisId",
- "valueId",
- "axisLabel",
- "valueLabel"
- ],
- "type": "object"
- },
- "maxItems": 8,
- "type": "array"
- },
- "policyId": {
- "description": "Which pricing policy this context follows.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "policyVersion": {
- "description": "The version of that pricing policy.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "recurringConditions": {
- "description": "What must remain true for this recurring unit price.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "source": {
- "description": "What the supplier states about this price, in its own words.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "basis",
- "policyId",
- "policyVersion",
- "source",
- "recurringConditions",
- "newDesignSetup",
- "physicalSelections"
- ],
- "type": "object"
- },
- "pricingPlan": {
- "description": "The supplier plan this price uses, such as Standard pricing.",
- "type": "string"
- },
- "product": {
- "description": "The supplier's own name for the product.",
- "type": "string"
- },
- "productUrl": {
- "description": "The supplier's page for this product and configuration.",
- "format": "uri",
- "type": "string"
- },
- "profit": {
- "anyOf": [
- {
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "dutyStatus": {
- "description": "How well the supplier-billed duty is established: known, estimated from bounded quotes, or unknown.",
- "enum": [
- "known",
- "estimated",
- "unknown"
- ],
- "type": "string"
- },
- "estimatedDutyDeducted": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The estimated duty deducted from the sale; null when duty is known or was not deducted."
- },
- "feeBreakdown": {
- "description": "Each platform fee and its amount.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The fee amount in the response currency.",
- "type": "number"
- },
- "label": {
- "description": "The fee's name, such as transaction fee.",
- "type": "string"
- }
- },
- "required": [
- "label",
- "amount"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "fees": {
- "description": "Platform fees for this sale in the response currency.",
- "type": "number"
- },
- "keep": {
- "description": "What the seller keeps per sale before tax, in the response currency.",
- "type": "number"
- },
- "margin": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Share of the sale the seller keeps, 0 to 1; null when the sale is zero."
- },
- "qualification": {
- "description": "In words, whether supplier-billed duty is included in or left out of this profit.",
- "type": "string"
- },
- "sale": {
- "description": "The selling price in the response currency; with targetMargin, the price to charge.",
- "type": "number"
- },
- "status": {
- "const": "calculated",
- "description": "Profit could be worked out for this offer.",
- "type": "string"
- },
- "supplierCost": {
- "description": "What the supplier charges in the response currency: product, shipping and any known duty.",
- "type": "number"
- }
- },
- "required": [
- "status",
- "dutyStatus",
- "qualification",
- "sale",
- "supplierCost",
- "fees",
- "feeBreakdown",
- "keep",
- "margin"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "reason": {
- "description": "Why: the supplier cost is unknown, the platform fees are unavailable, or the target margin cannot be reached.",
- "enum": [
- "missing_cost",
- "fees_unavailable",
- "target_not_reachable"
- ],
- "type": "string"
- },
- "status": {
- "const": "unavailable",
- "description": "Profit could not be worked out for this offer.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "reason"
- ],
- "type": "object"
- }
- ]
- },
- {
- "type": "null"
- }
- ],
- "description": "This offer's profit when a selling price or target margin was given; null otherwise."
- },
- "provider": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The print provider that makes the order, for a marketplace; null for a direct supplier."
- },
- "shipping": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Shipping cost in the response currency; null when unknown, never 0."
- },
- "sourceCurrency": {
- "anyOf": [
- {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The currency the supplier quoted its price in, before conversion to the response currency; null when no quote exists."
- },
- "supplier": {
- "description": "The supplier's name.",
- "type": "string"
- },
- "supplierId": {
- "description": "The supplier's id.",
- "type": "string"
- },
- "taxNote": {
- "description": "How VAT or sales tax applies to this price, in words.",
- "type": "string"
- },
- "versusYours": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Per sale against the seller's own supplier: positive means the seller keeps more here. Uses profit when shown, otherwise the delivered total; null when the two cannot be compared."
- }
- },
- "required": [
- "supplierId",
- "supplier",
- "provider",
- "product",
- "price",
- "shipping",
- "duty",
- "priceBasis",
- "delivered",
- "currency",
- "available",
- "comparable",
- "cheapest",
- "mostKept",
- "isYourSupplier",
- "profit",
- "versusYours",
- "note",
- "criticalDifferences",
- "differencesUnresolved",
- "pricingPlan",
- "deliveryDaysMin",
- "deliveryDaysMax",
- "checkedAt",
- "actionUrl",
- "productUrl",
- "affiliate",
- "facts"
- ],
- "type": "object"
- },
- "maxItems": 50,
- "type": "array"
- }
- },
- "required": [
- "offer",
- "otherOffers",
- "otherOfferCount"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "currency": {
- "description": "Currency for every price, such as USD, GBP or EUR.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "destination": {
- "description": "The buyer's country these prices are for.",
- "enum": [
- "US",
- "GB",
- "DE",
- "AU",
- "CA"
- ],
- "type": "string"
- },
- "ok": {
- "const": true,
- "type": "boolean"
- },
- "optionChoices": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The selected option by field, such as { size: \"Adult M\", color: \"Black\" }.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "optionCount": {
- "description": "How many configurations the product supports in total, before the 100 listed in options.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "optionKey": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The configuration compared, from the product's options; null when the product has none."
- },
- "optionLabel": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "That configuration in words, such as `Adult M / Black`; null when the product has none."
- },
- "options": {
- "description": "Up to 100 configurations the product supports, to pass as optionKey.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "key": {
- "description": "The configuration's key, to pass as optionKey.",
- "type": "string"
- },
- "label": {
- "description": "The configuration in words, such as `Adult M / Black`.",
- "type": "string"
- }
- },
- "required": [
- "key",
- "label"
- ],
- "type": "object"
- },
- "maxItems": 100,
- "type": "array"
- },
- "priceContext": {
- "description": "What the prices cover and which option they reflect, in words.",
- "type": "string"
- },
- "pricingTier": {
- "description": "The supplier plan the prices come from: base is standard, tier1 and tier2 are paid plans.",
- "enum": [
- "base",
- "tier1",
- "tier2"
- ],
- "type": "string"
- },
- "product": {
- "additionalProperties": false,
- "description": "The product that was compared.",
- "properties": {
- "category": {
- "description": "The category slug from the product's path, such as `t-shirts`.",
- "type": "string"
- },
- "id": {
- "description": "The product's id.",
- "type": "string"
- },
- "name": {
- "description": "The product's name.",
- "type": "string"
- },
- "subtitle": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "A short qualifier under the name; null when there is none."
- },
- "url": {
- "description": "The product's comparison page with these choices applied.",
- "format": "uri",
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "subtitle",
- "category",
- "url"
- ],
- "type": "object"
- },
- "profit": {
- "description": "Whether profit is shown, and the selling price or target margin it uses.",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "status": {
- "const": "off",
- "description": "No selling price or target margin was given, so profit is not calculated.",
- "type": "string"
- }
- },
- "required": [
- "status"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "message": {
- "description": "What to ask the seller, in words.",
- "type": "string"
- },
- "missing": {
- "description": "What to ask the seller for.",
- "items": {
- "enum": [
- "salesChannel",
- "shopLocation"
- ],
- "type": "string"
- },
- "minItems": 1,
- "type": "array"
- },
- "status": {
- "const": "needs_input",
- "description": "Profit needs the sales channel or the shop country before it can be calculated.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "missing",
- "message"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "message": {
- "description": "Why profit is unavailable, in words.",
- "type": "string"
- },
- "status": {
- "const": "unavailable",
- "description": "Profit cannot be calculated for this comparison.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "message"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "fallbackFromLabel": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Set when the requested channel has no fees for the shop, so another was used."
- },
- "feesCheckedAt": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The date of the fee research in use, as `YYYY-MM-DD`; null when unknown."
- },
- "mode": {
- "description": "selling-price uses the price the seller gave; target-margin returns the price to charge.",
- "enum": [
- "selling-price",
- "target-margin"
- ],
- "type": "string"
- },
- "salesChannel": {
- "description": "The sales channel whose platform fees apply.",
- "enum": [
- "etsy",
- "shopify",
- "woocommerce",
- "tiktok-shop"
- ],
- "type": "string"
- },
- "salesChannelLabel": {
- "description": "That sales channel as a person would say it.",
- "type": "string"
- },
- "sellingPrice": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The selling price given, in the response currency; null with targetMargin."
- },
- "shopLocation": {
- "description": "The country the seller's shop is based in, which sets the fees.",
- "enum": [
- "US",
- "GB",
- "DE",
- "AU",
- "CA"
- ],
- "type": "string"
- },
- "status": {
- "const": "ready",
- "description": "Profit is calculated for every offer whose supplier cost is complete.",
- "type": "string"
- },
- "targetMargin": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The target margin in percent; null with sellingPrice."
- }
- },
- "required": [
- "status",
- "mode",
- "sellingPrice",
- "targetMargin",
- "salesChannel",
- "salesChannelLabel",
- "shopLocation",
- "fallbackFromLabel",
- "feesCheckedAt"
- ],
- "type": "object"
- }
- ]
- },
- "servedAt": {
- "description": "When this comparison's data was read, as an ISO date-time.",
- "type": "string"
- },
- "supplier": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "id": {
- "description": "The supplier's id.",
- "type": "string"
- },
- "name": {
- "description": "The supplier's name.",
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "Set when the request asked for one supplier's offers."
- },
- "suppliers": {
- "description": "One entry per supplier, the seller's own pinned first when given, then most profit first when profit is shown.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "offer": {
- "additionalProperties": false,
- "description": "The offer this supplier's row shows.",
- "properties": {
- "actionUrl": {
- "description": "The main link out to this offer: the supplier's product page, or its sign-up page when the affiliate programme pays only for sign-ups.",
- "format": "uri",
- "type": "string"
- },
- "affiliate": {
- "description": "Whether actionUrl earns a commission; it never changes prices or rankings.",
- "type": "boolean"
- },
- "available": {
- "description": "The supplier sells this configuration and quotes it for the destination.",
- "type": "boolean"
- },
- "buyerImportWarning": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "A charge the buyer may pay on import, in words; null when there is none."
- },
- "cheapest": {
- "description": "Has the lowest product plus shipping total among comparable offers; false when the comparison cannot rank suppliers.",
- "type": "boolean"
- },
- "checkedAt": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "When this price was last checked, as an ISO date-time; null when unknown."
- },
- "comparable": {
- "description": "The priced configuration matches the requested choice closely enough to compare.",
- "type": "boolean"
- },
- "criticalDifferences": {
- "description": "Ways this product differs from the one asked about; empty for the same product.",
- "items": {
- "minLength": 1,
- "type": "string"
- },
- "type": "array"
- },
- "currency": {
- "anyOf": [
- {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The currency these amounts are in; null when no price is known."
- },
- "delivered": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Product plus shipping in the response currency; null when the supplier cannot price it, never 0."
- },
- "deliveryDaysMax": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's longest stated delivery time, in days from order to arrival; null when unknown."
- },
- "deliveryDaysMin": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's shortest stated delivery time, in days from order to arrival; null when unknown."
- },
- "differencesUnresolved": {
- "anyOf": [
- {
- "minLength": 1,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "A difference that could not be confirmed; null when everything is known."
- },
- "duty": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Supplier-billed duty in the response currency, separate from the delivered total; 0 when the supplier bills none, null when unverified."
- },
- "dutyEstimate": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "converted": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "currency": {
- "description": "The currency of these duty amounts.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "max": {
- "description": "Highest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- },
- "min": {
- "description": "Lowest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- }
- },
- "required": [
- "min",
- "max",
- "currency"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The same estimate in the response currency; null when it could not be converted."
- },
- "native": {
- "additionalProperties": false,
- "description": "The duty estimate in the supplier's own currency.",
- "properties": {
- "basis": {
- "const": "line_net_x_compatible_product_rate",
- "description": "How the estimate was derived: the line's net price times the supplier's per-product duty rate.",
- "type": "string"
- },
- "currency": {
- "description": "The currency of these duty amounts.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "max": {
- "description": "Highest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- },
- "min": {
- "description": "Lowest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- }
- },
- "required": [
- "min",
- "max",
- "currency",
- "basis"
- ],
- "type": "object"
- }
- },
- "required": [
- "native",
- "converted"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The bounded duty estimate when only a range is known; absent otherwise."
- },
- "dutyOutcome": {
- "anyOf": [
- {
- "enum": [
- "charged",
- "not_applicable",
- "estimated",
- "unknown"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "charged when the supplier bills duty, not_applicable when none applies, estimated when only a range is known, unknown when unverified."
- },
- "dutySource": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The supplier's own duty amount, in its own currency.",
- "minimum": 0,
- "type": "number"
- },
- "currency": {
- "description": "The currency the supplier states that duty in.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- }
- },
- "required": [
- "amount",
- "currency"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's own duty charge as it states it; null when none is published."
- },
- "facts": {
- "description": "Labelled facts about this offer, such as print method, size range and quantity.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "label": {
- "description": "What the fact is about.",
- "type": "string"
- },
- "value": {
- "description": "The fact's value.",
- "type": "string"
- }
- },
- "required": [
- "label",
- "value"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "isYourSupplier": {
- "description": "The supplier the seller said they use today.",
- "type": "boolean"
- },
- "mostKept": {
- "description": "Leaves the seller the most per sale; false unless profit is shown and every supplier-billed duty is known.",
- "type": "boolean"
- },
- "note": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "How this offer's configuration differs from the one asked about, in words; null when there is nothing to add."
- },
- "price": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Product cost in the response currency, before shipping; null when unknown, never 0."
- },
- "priceBasis": {
- "const": "product-and-shipping",
- "description": "What the delivered total covers: product and shipping.",
- "type": "string"
- },
- "pricingBasis": {
- "description": "The selected price basis and any setup disclosure, in words.",
- "type": "string"
- },
- "pricingContext": {
- "additionalProperties": false,
- "description": "Present when this price only holds under stated conditions, such as a design the seller already has.",
- "properties": {
- "basis": {
- "description": "What the price assumes: an existing design the seller already has, or included digitisation.",
- "enum": [
- "existing-supplier-digitised-design",
- "digitisation-included"
- ],
- "type": "string"
- },
- "newDesignSetup": {
- "description": "How a new design's setup is charged, or that it is included.",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "applicability": {
- "description": "design-dependent when the fee depends on the artwork, selected when one fee applies to this order.",
- "enum": [
- "design-dependent",
- "selected"
- ],
- "type": "string"
- },
- "application": {
- "const": "not-modelled",
- "description": "Always not-modelled: the charge is disclosed but never added to a total.",
- "type": "string"
- },
- "fees": {
- "description": "The setup fees the supplier lists.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The fee amount in its own currency.",
- "minimum": 0,
- "type": "number"
- },
- "conditions": {
- "description": "What must hold for this fee to apply.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "currency": {
- "description": "Original supplier currency; never converted along with the unit price.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "kind": {
- "description": "What the fee is for: standard, text-only, image, adjustment, back-or-side or setup.",
- "enum": [
- "standard",
- "text-only",
- "image",
- "adjustment",
- "back-or-side",
- "setup"
- ],
- "type": "string"
- },
- "scope": {
- "description": "What the fee applies to: per design, per design and area, per order, per unit or unknown.",
- "enum": [
- "per-design",
- "per-design-and-area",
- "per-order",
- "per-unit",
- "unknown"
- ],
- "type": "string"
- },
- "source": {
- "description": "What the supplier states about this fee.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "taxBasis": {
- "description": "Whether the fee is quoted before VAT (ex-vat) or unclear.",
- "enum": [
- "ex-vat",
- "unknown"
- ],
- "type": "string"
- }
- },
- "required": [
- "kind",
- "amount",
- "currency",
- "taxBasis",
- "scope",
- "source",
- "conditions"
- ],
- "type": "object"
- },
- "maxItems": 8,
- "minItems": 1,
- "type": "array"
- },
- "includedInDeliveredTotal": {
- "const": false,
- "description": "Always false: setup charges stay outside the delivered total.",
- "type": "boolean"
- },
- "status": {
- "const": "listed",
- "description": "The supplier lists a setup charge.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "fees",
- "applicability",
- "application",
- "includedInDeliveredTotal"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "conditions": {
- "description": "What must hold for the inclusion.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "source": {
- "description": "What the supplier states about the inclusion.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "status": {
- "const": "included",
- "description": "Digitisation is included, so there is no setup charge.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "source",
- "conditions"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "reason": {
- "description": "Why the setup charge is unknown.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "source": {
- "description": "What the supplier states, when it says anything.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "status": {
- "const": "unknown",
- "description": "Whether a setup charge applies could not be established.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "reason"
- ],
- "type": "object"
- }
- ]
- },
- "physicalSelections": {
- "description": "The supplier options this price was quoted for.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "axisId": {
- "description": "The option field's id, such as size.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "axisLabel": {
- "description": "The option field as shown, such as Size.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "kind": {
- "description": "sku-option changes the unit price; standard-configuration is a fixed default.",
- "enum": [
- "sku-option",
- "standard-configuration"
- ],
- "type": "string"
- },
- "valueId": {
- "description": "The chosen value's id.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "valueLabel": {
- "description": "The chosen value as shown, such as Adult M.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "kind",
- "axisId",
- "valueId",
- "axisLabel",
- "valueLabel"
- ],
- "type": "object"
- },
- "maxItems": 8,
- "type": "array"
- },
- "policyId": {
- "description": "Which pricing policy this context follows.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "policyVersion": {
- "description": "The version of that pricing policy.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "recurringConditions": {
- "description": "What must remain true for this recurring unit price.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "source": {
- "description": "What the supplier states about this price, in its own words.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "basis",
- "policyId",
- "policyVersion",
- "source",
- "recurringConditions",
- "newDesignSetup",
- "physicalSelections"
- ],
- "type": "object"
- },
- "pricingPlan": {
- "description": "The supplier plan this price uses, such as Standard pricing.",
- "type": "string"
- },
- "product": {
- "description": "The supplier's own name for the product.",
- "type": "string"
- },
- "productUrl": {
- "description": "The supplier's page for this product and configuration.",
- "format": "uri",
- "type": "string"
- },
- "profit": {
- "anyOf": [
- {
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "dutyStatus": {
- "description": "How well the supplier-billed duty is established: known, estimated from bounded quotes, or unknown.",
- "enum": [
- "known",
- "estimated",
- "unknown"
- ],
- "type": "string"
- },
- "estimatedDutyDeducted": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The estimated duty deducted from the sale; null when duty is known or was not deducted."
- },
- "feeBreakdown": {
- "description": "Each platform fee and its amount.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The fee amount in the response currency.",
- "type": "number"
- },
- "label": {
- "description": "The fee's name, such as transaction fee.",
- "type": "string"
- }
- },
- "required": [
- "label",
- "amount"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "fees": {
- "description": "Platform fees for this sale in the response currency.",
- "type": "number"
- },
- "keep": {
- "description": "What the seller keeps per sale before tax, in the response currency.",
- "type": "number"
- },
- "margin": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Share of the sale the seller keeps, 0 to 1; null when the sale is zero."
- },
- "qualification": {
- "description": "In words, whether supplier-billed duty is included in or left out of this profit.",
- "type": "string"
- },
- "sale": {
- "description": "The selling price in the response currency; with targetMargin, the price to charge.",
- "type": "number"
- },
- "status": {
- "const": "calculated",
- "description": "Profit could be worked out for this offer.",
- "type": "string"
- },
- "supplierCost": {
- "description": "What the supplier charges in the response currency: product, shipping and any known duty.",
- "type": "number"
- }
- },
- "required": [
- "status",
- "dutyStatus",
- "qualification",
- "sale",
- "supplierCost",
- "fees",
- "feeBreakdown",
- "keep",
- "margin"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "reason": {
- "description": "Why: the supplier cost is unknown, the platform fees are unavailable, or the target margin cannot be reached.",
- "enum": [
- "missing_cost",
- "fees_unavailable",
- "target_not_reachable"
- ],
- "type": "string"
- },
- "status": {
- "const": "unavailable",
- "description": "Profit could not be worked out for this offer.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "reason"
- ],
- "type": "object"
- }
- ]
- },
- {
- "type": "null"
- }
- ],
- "description": "This offer's profit when a selling price or target margin was given; null otherwise."
- },
- "provider": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The print provider that makes the order, for a marketplace; null for a direct supplier."
- },
- "shipping": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Shipping cost in the response currency; null when unknown, never 0."
- },
- "sourceCurrency": {
- "anyOf": [
- {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The currency the supplier quoted its price in, before conversion to the response currency; null when no quote exists."
- },
- "supplier": {
- "description": "The supplier's name.",
- "type": "string"
- },
- "supplierId": {
- "description": "The supplier's id.",
- "type": "string"
- },
- "taxNote": {
- "description": "How VAT or sales tax applies to this price, in words.",
- "type": "string"
- },
- "versusYours": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Per sale against the seller's own supplier: positive means the seller keeps more here. Uses profit when shown, otherwise the delivered total; null when the two cannot be compared."
- }
- },
- "required": [
- "supplierId",
- "supplier",
- "provider",
- "product",
- "price",
- "shipping",
- "duty",
- "priceBasis",
- "delivered",
- "currency",
- "available",
- "comparable",
- "cheapest",
- "mostKept",
- "isYourSupplier",
- "profit",
- "versusYours",
- "note",
- "criticalDifferences",
- "differencesUnresolved",
- "pricingPlan",
- "deliveryDaysMin",
- "deliveryDaysMax",
- "checkedAt",
- "actionUrl",
- "productUrl",
- "affiliate",
- "facts"
- ],
- "type": "object"
- },
- "otherOfferCount": {
- "description": "How many other offers this supplier has, including any beyond otherOffers.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "otherOffers": {
- "description": "This supplier's other products and print providers for the choice.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "actionUrl": {
- "description": "The main link out to this offer: the supplier's product page, or its sign-up page when the affiliate programme pays only for sign-ups.",
- "format": "uri",
- "type": "string"
- },
- "affiliate": {
- "description": "Whether actionUrl earns a commission; it never changes prices or rankings.",
- "type": "boolean"
- },
- "available": {
- "description": "The supplier sells this configuration and quotes it for the destination.",
- "type": "boolean"
- },
- "buyerImportWarning": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "A charge the buyer may pay on import, in words; null when there is none."
- },
- "cheapest": {
- "description": "Has the lowest product plus shipping total among comparable offers; false when the comparison cannot rank suppliers.",
- "type": "boolean"
- },
- "checkedAt": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "When this price was last checked, as an ISO date-time; null when unknown."
- },
- "comparable": {
- "description": "The priced configuration matches the requested choice closely enough to compare.",
- "type": "boolean"
- },
- "criticalDifferences": {
- "description": "Ways this product differs from the one asked about; empty for the same product.",
- "items": {
- "minLength": 1,
- "type": "string"
- },
- "type": "array"
- },
- "currency": {
- "anyOf": [
- {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The currency these amounts are in; null when no price is known."
- },
- "delivered": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Product plus shipping in the response currency; null when the supplier cannot price it, never 0."
- },
- "deliveryDaysMax": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's longest stated delivery time, in days from order to arrival; null when unknown."
- },
- "deliveryDaysMin": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's shortest stated delivery time, in days from order to arrival; null when unknown."
- },
- "differencesUnresolved": {
- "anyOf": [
- {
- "minLength": 1,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "A difference that could not be confirmed; null when everything is known."
- },
- "duty": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Supplier-billed duty in the response currency, separate from the delivered total; 0 when the supplier bills none, null when unverified."
- },
- "dutyEstimate": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "converted": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "currency": {
- "description": "The currency of these duty amounts.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "max": {
- "description": "Highest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- },
- "min": {
- "description": "Lowest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- }
- },
- "required": [
- "min",
- "max",
- "currency"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The same estimate in the response currency; null when it could not be converted."
- },
- "native": {
- "additionalProperties": false,
- "description": "The duty estimate in the supplier's own currency.",
- "properties": {
- "basis": {
- "const": "line_net_x_compatible_product_rate",
- "description": "How the estimate was derived: the line's net price times the supplier's per-product duty rate.",
- "type": "string"
- },
- "currency": {
- "description": "The currency of these duty amounts.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "max": {
- "description": "Highest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- },
- "min": {
- "description": "Lowest amount in this duty range, in this currency.",
- "minimum": 0,
- "type": "number"
- }
- },
- "required": [
- "min",
- "max",
- "currency",
- "basis"
- ],
- "type": "object"
- }
- },
- "required": [
- "native",
- "converted"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The bounded duty estimate when only a range is known; absent otherwise."
- },
- "dutyOutcome": {
- "anyOf": [
- {
- "enum": [
- "charged",
- "not_applicable",
- "estimated",
- "unknown"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "charged when the supplier bills duty, not_applicable when none applies, estimated when only a range is known, unknown when unverified."
- },
- "dutySource": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The supplier's own duty amount, in its own currency.",
- "minimum": 0,
- "type": "number"
- },
- "currency": {
- "description": "The currency the supplier states that duty in.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- }
- },
- "required": [
- "amount",
- "currency"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier's own duty charge as it states it; null when none is published."
- },
- "facts": {
- "description": "Labelled facts about this offer, such as print method, size range and quantity.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "label": {
- "description": "What the fact is about.",
- "type": "string"
- },
- "value": {
- "description": "The fact's value.",
- "type": "string"
- }
- },
- "required": [
- "label",
- "value"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "isYourSupplier": {
- "description": "The supplier the seller said they use today.",
- "type": "boolean"
- },
- "mostKept": {
- "description": "Leaves the seller the most per sale; false unless profit is shown and every supplier-billed duty is known.",
- "type": "boolean"
- },
- "note": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "How this offer's configuration differs from the one asked about, in words; null when there is nothing to add."
- },
- "price": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Product cost in the response currency, before shipping; null when unknown, never 0."
- },
- "priceBasis": {
- "const": "product-and-shipping",
- "description": "What the delivered total covers: product and shipping.",
- "type": "string"
- },
- "pricingBasis": {
- "description": "The selected price basis and any setup disclosure, in words.",
- "type": "string"
- },
- "pricingContext": {
- "additionalProperties": false,
- "description": "Present when this price only holds under stated conditions, such as a design the seller already has.",
- "properties": {
- "basis": {
- "description": "What the price assumes: an existing design the seller already has, or included digitisation.",
- "enum": [
- "existing-supplier-digitised-design",
- "digitisation-included"
- ],
- "type": "string"
- },
- "newDesignSetup": {
- "description": "How a new design's setup is charged, or that it is included.",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "applicability": {
- "description": "design-dependent when the fee depends on the artwork, selected when one fee applies to this order.",
- "enum": [
- "design-dependent",
- "selected"
- ],
- "type": "string"
- },
- "application": {
- "const": "not-modelled",
- "description": "Always not-modelled: the charge is disclosed but never added to a total.",
- "type": "string"
- },
- "fees": {
- "description": "The setup fees the supplier lists.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The fee amount in its own currency.",
- "minimum": 0,
- "type": "number"
- },
- "conditions": {
- "description": "What must hold for this fee to apply.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "currency": {
- "description": "Original supplier currency; never converted along with the unit price.",
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- "kind": {
- "description": "What the fee is for: standard, text-only, image, adjustment, back-or-side or setup.",
- "enum": [
- "standard",
- "text-only",
- "image",
- "adjustment",
- "back-or-side",
- "setup"
- ],
- "type": "string"
- },
- "scope": {
- "description": "What the fee applies to: per design, per design and area, per order, per unit or unknown.",
- "enum": [
- "per-design",
- "per-design-and-area",
- "per-order",
- "per-unit",
- "unknown"
- ],
- "type": "string"
- },
- "source": {
- "description": "What the supplier states about this fee.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "taxBasis": {
- "description": "Whether the fee is quoted before VAT (ex-vat) or unclear.",
- "enum": [
- "ex-vat",
- "unknown"
- ],
- "type": "string"
- }
- },
- "required": [
- "kind",
- "amount",
- "currency",
- "taxBasis",
- "scope",
- "source",
- "conditions"
- ],
- "type": "object"
- },
- "maxItems": 8,
- "minItems": 1,
- "type": "array"
- },
- "includedInDeliveredTotal": {
- "const": false,
- "description": "Always false: setup charges stay outside the delivered total.",
- "type": "boolean"
- },
- "status": {
- "const": "listed",
- "description": "The supplier lists a setup charge.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "fees",
- "applicability",
- "application",
- "includedInDeliveredTotal"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "conditions": {
- "description": "What must hold for the inclusion.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "source": {
- "description": "What the supplier states about the inclusion.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "status": {
- "const": "included",
- "description": "Digitisation is included, so there is no setup charge.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "source",
- "conditions"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "reason": {
- "description": "Why the setup charge is unknown.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "source": {
- "description": "What the supplier states, when it says anything.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "status": {
- "const": "unknown",
- "description": "Whether a setup charge applies could not be established.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "reason"
- ],
- "type": "object"
- }
- ]
- },
- "physicalSelections": {
- "description": "The supplier options this price was quoted for.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "axisId": {
- "description": "The option field's id, such as size.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "axisLabel": {
- "description": "The option field as shown, such as Size.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "kind": {
- "description": "sku-option changes the unit price; standard-configuration is a fixed default.",
- "enum": [
- "sku-option",
- "standard-configuration"
- ],
- "type": "string"
- },
- "valueId": {
- "description": "The chosen value's id.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "valueLabel": {
- "description": "The chosen value as shown, such as Adult M.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "kind",
- "axisId",
- "valueId",
- "axisLabel",
- "valueLabel"
- ],
- "type": "object"
- },
- "maxItems": 8,
- "type": "array"
- },
- "policyId": {
- "description": "Which pricing policy this context follows.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "policyVersion": {
- "description": "The version of that pricing policy.",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- },
- "recurringConditions": {
- "description": "What must remain true for this recurring unit price.",
- "items": {
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- },
- "maxItems": 12,
- "type": "array"
- },
- "source": {
- "description": "What the supplier states about this price, in its own words.",
- "maxLength": 600,
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "basis",
- "policyId",
- "policyVersion",
- "source",
- "recurringConditions",
- "newDesignSetup",
- "physicalSelections"
- ],
- "type": "object"
- },
- "pricingPlan": {
- "description": "The supplier plan this price uses, such as Standard pricing.",
- "type": "string"
- },
- "product": {
- "description": "The supplier's own name for the product.",
- "type": "string"
- },
- "productUrl": {
- "description": "The supplier's page for this product and configuration.",
- "format": "uri",
- "type": "string"
- },
- "profit": {
- "anyOf": [
- {
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "dutyStatus": {
- "description": "How well the supplier-billed duty is established: known, estimated from bounded quotes, or unknown.",
- "enum": [
- "known",
- "estimated",
- "unknown"
- ],
- "type": "string"
- },
- "estimatedDutyDeducted": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "The estimated duty deducted from the sale; null when duty is known or was not deducted."
- },
- "feeBreakdown": {
- "description": "Each platform fee and its amount.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "description": "The fee amount in the response currency.",
- "type": "number"
- },
- "label": {
- "description": "The fee's name, such as transaction fee.",
- "type": "string"
- }
- },
- "required": [
- "label",
- "amount"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "fees": {
- "description": "Platform fees for this sale in the response currency.",
- "type": "number"
- },
- "keep": {
- "description": "What the seller keeps per sale before tax, in the response currency.",
- "type": "number"
- },
- "margin": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Share of the sale the seller keeps, 0 to 1; null when the sale is zero."
- },
- "qualification": {
- "description": "In words, whether supplier-billed duty is included in or left out of this profit.",
- "type": "string"
- },
- "sale": {
- "description": "The selling price in the response currency; with targetMargin, the price to charge.",
- "type": "number"
- },
- "status": {
- "const": "calculated",
- "description": "Profit could be worked out for this offer.",
- "type": "string"
- },
- "supplierCost": {
- "description": "What the supplier charges in the response currency: product, shipping and any known duty.",
- "type": "number"
- }
- },
- "required": [
- "status",
- "dutyStatus",
- "qualification",
- "sale",
- "supplierCost",
- "fees",
- "feeBreakdown",
- "keep",
- "margin"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "reason": {
- "description": "Why: the supplier cost is unknown, the platform fees are unavailable, or the target margin cannot be reached.",
- "enum": [
- "missing_cost",
- "fees_unavailable",
- "target_not_reachable"
- ],
- "type": "string"
- },
- "status": {
- "const": "unavailable",
- "description": "Profit could not be worked out for this offer.",
- "type": "string"
- }
- },
- "required": [
- "status",
- "reason"
- ],
- "type": "object"
- }
- ]
- },
- {
- "type": "null"
- }
- ],
- "description": "This offer's profit when a selling price or target margin was given; null otherwise."
- },
- "provider": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The print provider that makes the order, for a marketplace; null for a direct supplier."
- },
- "shipping": {
- "anyOf": [
- {
- "minimum": 0,
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Shipping cost in the response currency; null when unknown, never 0."
- },
- "sourceCurrency": {
- "anyOf": [
- {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "AUD",
- "CAD"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The currency the supplier quoted its price in, before conversion to the response currency; null when no quote exists."
- },
- "supplier": {
- "description": "The supplier's name.",
- "type": "string"
- },
- "supplierId": {
- "description": "The supplier's id.",
- "type": "string"
- },
- "taxNote": {
- "description": "How VAT or sales tax applies to this price, in words.",
- "type": "string"
- },
- "versusYours": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Per sale against the seller's own supplier: positive means the seller keeps more here. Uses profit when shown, otherwise the delivered total; null when the two cannot be compared."
- }
- },
- "required": [
- "supplierId",
- "supplier",
- "provider",
- "product",
- "price",
- "shipping",
- "duty",
- "priceBasis",
- "delivered",
- "currency",
- "available",
- "comparable",
- "cheapest",
- "mostKept",
- "isYourSupplier",
- "profit",
- "versusYours",
- "note",
- "criticalDifferences",
- "differencesUnresolved",
- "pricingPlan",
- "deliveryDaysMin",
- "deliveryDaysMax",
- "checkedAt",
- "actionUrl",
- "productUrl",
- "affiliate",
- "facts"
- ],
- "type": "object"
- },
- "maxItems": 50,
- "type": "array"
- }
- },
- "required": [
- "offer",
- "otherOffers",
- "otherOfferCount"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "yourSupplier": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "id": {
- "description": "The supplier's id.",
- "type": "string"
- },
- "name": {
- "description": "The supplier's name.",
- "type": "string"
- },
- "sellsProduct": {
- "description": "False when the supplier does not sell this product in this configuration.",
- "type": "boolean"
- }
- },
- "required": [
- "id",
- "name",
- "sellsProduct"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The supplier the seller said they use; null when they did not say."
- }
- },
- "required": [
- "ok",
- "product",
- "destination",
- "currency",
- "pricingTier",
- "optionKey",
- "optionLabel",
- "optionChoices",
- "profit",
- "yourSupplier",
- "supplier",
- "options",
- "optionCount",
- "suppliers",
- "alternatives",
- "priceContext",
- "servedAt",
- "affiliateDisclosure"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "error": {
- "additionalProperties": false,
- "description": "The error this call returned instead of a result.",
- "properties": {
- "code": {
- "description": "The machine-readable reason the call failed.",
- "enum": [
- "invalid_input",
- "not_found",
- "product_not_found",
- "invalid_option",
- "comparison_unavailable",
- "unavailable",
- "rate_limited"
- ],
- "type": "string"
- },
- "message": {
- "description": "What went wrong, in words, and what to do next.",
- "type": "string"
- },
- "retryable": {
- "description": "Whether calling again could succeed.",
- "type": "boolean"
- }
- },
- "required": [
- "code",
- "message",
- "retryable"
- ],
- "type": "object"
- },
- "ok": {
- "const": false,
- "type": "boolean"
- }
- },
- "required": [
- "ok",
- "error"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "affiliateDisclosure": {
+ "description": "The commission disclosure that applies to affiliate links.",
+ "type": "string"
+ },
+ "alternatives": {
+ "description": "Similar products compared alongside, kept separate from the same product's suppliers.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "offer": {
+ "additionalProperties": false,
+ "description": "The offer this supplier's row shows.",
+ "properties": {
+ "actionUrl": {
+ "description": "The main link out to this offer: the supplier's product page, or its sign-up page when the affiliate programme pays only for sign-ups.",
+ "format": "uri",
+ "type": "string"
+ },
+ "affiliate": {
+ "description": "Whether actionUrl earns a commission; it never changes prices or rankings.",
+ "type": "boolean"
+ },
+ "available": {
+ "description": "The supplier sells this configuration and quotes it for the destination.",
+ "type": "boolean"
+ },
+ "buyerImportWarning": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A charge the buyer may pay on import, in words; null when there is none."
+ },
+ "cheapest": {
+ "description": "Has the lowest product plus shipping total among comparable offers; false when the comparison cannot rank suppliers.",
+ "type": "boolean"
+ },
+ "checkedAt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "When this price was last checked, as an ISO date-time; null when unknown."
+ },
+ "comparable": {
+ "description": "The priced configuration matches the requested choice closely enough to compare.",
+ "type": "boolean"
+ },
+ "criticalDifferences": {
+ "description": "Ways this product differs from the one asked about; empty for the same product.",
+ "items": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "currency": {
+ "anyOf": [
+ {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The currency these amounts are in; null when no price is known."
+ },
+ "delivered": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Product plus shipping in the response currency; null when the supplier cannot price it, never 0."
+ },
+ "deliveryDaysMax": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's longest stated delivery time, in days from order to arrival; null when unknown."
+ },
+ "deliveryDaysMin": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's shortest stated delivery time, in days from order to arrival; null when unknown."
+ },
+ "differencesUnresolved": {
+ "anyOf": [
+ {
+ "minLength": 1,
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A difference that could not be confirmed; null when everything is known."
+ },
+ "duty": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Supplier-billed duty in the response currency, separate from the delivered total; 0 when the supplier bills none, null when unverified."
+ },
+ "dutyEstimate": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "converted": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "currency": {
+ "description": "The currency of these duty amounts.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "max": {
+ "description": "Highest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "min": {
+ "description": "Lowest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "min",
+ "max",
+ "currency"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The same estimate in the response currency; null when it could not be converted."
+ },
+ "native": {
+ "additionalProperties": false,
+ "description": "The duty estimate in the supplier's own currency.",
+ "properties": {
+ "basis": {
+ "const": "line_net_x_compatible_product_rate",
+ "description": "How the estimate was derived: the line's net price times the supplier's per-product duty rate.",
+ "type": "string"
+ },
+ "currency": {
+ "description": "The currency of these duty amounts.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "max": {
+ "description": "Highest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "min": {
+ "description": "Lowest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "min",
+ "max",
+ "currency",
+ "basis"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "native",
+ "converted"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The bounded duty estimate when only a range is known; absent otherwise."
+ },
+ "dutyOutcome": {
+ "anyOf": [
+ {
+ "enum": [
+ "charged",
+ "not_applicable",
+ "estimated",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "charged when the supplier bills duty, not_applicable when none applies, estimated when only a range is known, unknown when unverified."
+ },
+ "dutySource": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The supplier's own duty amount, in its own currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "currency": {
+ "description": "The currency the supplier states that duty in.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's own duty charge as it states it; null when none is published."
+ },
+ "facts": {
+ "description": "Labelled facts about this offer, such as print method, size range and quantity.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "label": {
+ "description": "What the fact is about.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The fact's value.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "label",
+ "value"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "isYourSupplier": {
+ "description": "The supplier the seller said they use today.",
+ "type": "boolean"
+ },
+ "mostKept": {
+ "description": "Leaves the seller the most per sale; false unless profit is shown and every supplier-billed duty is known.",
+ "type": "boolean"
+ },
+ "note": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "How this offer's configuration differs from the one asked about, in words; null when there is nothing to add."
+ },
+ "price": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Product cost in the response currency, before shipping; null when unknown, never 0."
+ },
+ "priceBasis": {
+ "const": "product-and-shipping",
+ "description": "What the delivered total covers: product and shipping.",
+ "type": "string"
+ },
+ "pricingBasis": {
+ "description": "The selected price basis and any setup disclosure, in words.",
+ "type": "string"
+ },
+ "pricingContext": {
+ "additionalProperties": false,
+ "description": "Present when this price only holds under stated conditions, such as a design the seller already has.",
+ "properties": {
+ "basis": {
+ "description": "What the price assumes: an existing design the seller already has, or included digitisation.",
+ "enum": [
+ "existing-supplier-digitised-design",
+ "digitisation-included"
+ ],
+ "type": "string"
+ },
+ "newDesignSetup": {
+ "description": "How a new design's setup is charged, or that it is included.",
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "applicability": {
+ "description": "design-dependent when the fee depends on the artwork, selected when one fee applies to this order.",
+ "enum": [
+ "design-dependent",
+ "selected"
+ ],
+ "type": "string"
+ },
+ "application": {
+ "const": "not-modelled",
+ "description": "Always not-modelled: the charge is disclosed but never added to a total.",
+ "type": "string"
+ },
+ "fees": {
+ "description": "The setup fees the supplier lists.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The fee amount in its own currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "conditions": {
+ "description": "What must hold for this fee to apply.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "currency": {
+ "description": "Original supplier currency; never converted along with the unit price.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "What the fee is for: standard, text-only, image, adjustment, back-or-side or setup.",
+ "enum": [
+ "standard",
+ "text-only",
+ "image",
+ "adjustment",
+ "back-or-side",
+ "setup"
+ ],
+ "type": "string"
+ },
+ "scope": {
+ "description": "What the fee applies to: per design, per design and area, per order, per unit or unknown.",
+ "enum": [
+ "per-design",
+ "per-design-and-area",
+ "per-order",
+ "per-unit",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "source": {
+ "description": "What the supplier states about this fee.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "taxBasis": {
+ "description": "Whether the fee is quoted before VAT (ex-vat) or unclear.",
+ "enum": [
+ "ex-vat",
+ "unknown"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "amount",
+ "currency",
+ "taxBasis",
+ "scope",
+ "source",
+ "conditions"
+ ],
+ "type": "object"
+ },
+ "maxItems": 8,
+ "minItems": 1,
+ "type": "array"
+ },
+ "includedInDeliveredTotal": {
+ "const": false,
+ "description": "Always false: setup charges stay outside the delivered total.",
+ "type": "boolean"
+ },
+ "status": {
+ "const": "listed",
+ "description": "The supplier lists a setup charge.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "fees",
+ "applicability",
+ "application",
+ "includedInDeliveredTotal"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "conditions": {
+ "description": "What must hold for the inclusion.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "source": {
+ "description": "What the supplier states about the inclusion.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "status": {
+ "const": "included",
+ "description": "Digitisation is included, so there is no setup charge.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "source",
+ "conditions"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "reason": {
+ "description": "Why the setup charge is unknown.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "source": {
+ "description": "What the supplier states, when it says anything.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "status": {
+ "const": "unknown",
+ "description": "Whether a setup charge applies could not be established.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "reason"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ "physicalSelections": {
+ "description": "The supplier options this price was quoted for.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "axisId": {
+ "description": "The option field's id, such as size.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "axisLabel": {
+ "description": "The option field as shown, such as Size.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "kind": {
+ "description": "sku-option changes the unit price; standard-configuration is a fixed default.",
+ "enum": [
+ "sku-option",
+ "standard-configuration"
+ ],
+ "type": "string"
+ },
+ "valueId": {
+ "description": "The chosen value's id.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "valueLabel": {
+ "description": "The chosen value as shown, such as Adult M.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "axisId",
+ "valueId",
+ "axisLabel",
+ "valueLabel"
+ ],
+ "type": "object"
+ },
+ "maxItems": 8,
+ "type": "array"
+ },
+ "policyId": {
+ "description": "Which pricing policy this context follows.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "policyVersion": {
+ "description": "The version of that pricing policy.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "recurringConditions": {
+ "description": "What must remain true for this recurring unit price.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "source": {
+ "description": "What the supplier states about this price, in its own words.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "basis",
+ "policyId",
+ "policyVersion",
+ "source",
+ "recurringConditions",
+ "newDesignSetup",
+ "physicalSelections"
+ ],
+ "type": "object"
+ },
+ "pricingPlan": {
+ "description": "The supplier plan this price uses, such as Standard pricing.",
+ "type": "string"
+ },
+ "pricingPlanId": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The stable id of that plan, such as `printify:premium`; pass it back instead of guessing from its name. Null when no price is known."
+ },
+ "product": {
+ "description": "The supplier's own name for the product.",
+ "type": "string"
+ },
+ "productUrl": {
+ "description": "The supplier's page for this product and configuration.",
+ "format": "uri",
+ "type": "string"
+ },
+ "profit": {
+ "anyOf": [
+ {
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "dutyStatus": {
+ "description": "How well the supplier-billed duty is established: known, estimated from bounded quotes, or unknown.",
+ "enum": [
+ "known",
+ "estimated",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "estimatedDutyDeducted": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The estimated duty deducted from the sale; null when duty is known or was not deducted."
+ },
+ "feeBreakdown": {
+ "description": "Each platform fee and its amount.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The fee amount in the response currency.",
+ "type": "number"
+ },
+ "label": {
+ "description": "The fee's name, such as transaction fee.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "label",
+ "amount"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees": {
+ "description": "Platform fees for this sale in the response currency.",
+ "type": "number"
+ },
+ "keep": {
+ "description": "What the seller keeps per sale before tax, in the response currency.",
+ "type": "number"
+ },
+ "margin": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Share of the sale the seller keeps, 0 to 1; null when the sale is zero."
+ },
+ "qualification": {
+ "description": "In words, whether supplier-billed duty is included in or left out of this profit.",
+ "type": "string"
+ },
+ "sale": {
+ "description": "The selling price in the response currency; with targetMargin, the price to charge.",
+ "type": "number"
+ },
+ "status": {
+ "const": "calculated",
+ "description": "Profit could be worked out for this offer.",
+ "type": "string"
+ },
+ "supplierCost": {
+ "description": "What the supplier charges in the response currency: product, shipping and any known duty.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "status",
+ "dutyStatus",
+ "qualification",
+ "sale",
+ "supplierCost",
+ "fees",
+ "feeBreakdown",
+ "keep",
+ "margin"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "reason": {
+ "description": "Why: the supplier cost is unknown, the platform fees are unavailable, or the target margin cannot be reached.",
+ "enum": [
+ "missing_cost",
+ "fees_unavailable",
+ "target_not_reachable"
+ ],
+ "type": "string"
+ },
+ "status": {
+ "const": "unavailable",
+ "description": "Profit could not be worked out for this offer.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "reason"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "This offer's profit when a selling price or target margin was given; null otherwise."
+ },
+ "provider": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The print provider that makes the order, for a marketplace; null for a direct supplier."
+ },
+ "shipping": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Shipping cost in the response currency; null when unknown, never 0."
+ },
+ "sourceCurrency": {
+ "anyOf": [
+ {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The currency the supplier quoted its price in, before conversion to the response currency; null when no quote exists."
+ },
+ "supplier": {
+ "description": "The supplier's name.",
+ "type": "string"
+ },
+ "supplierId": {
+ "description": "The supplier's id.",
+ "type": "string"
+ },
+ "taxNote": {
+ "description": "How VAT or sales tax applies to this price, in words.",
+ "type": "string"
+ },
+ "versusYours": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Per sale against the seller's own supplier: positive means the seller keeps more here. Uses profit when shown, otherwise the delivered total; null when the two cannot be compared."
+ }
+ },
+ "required": [
+ "supplierId",
+ "supplier",
+ "provider",
+ "product",
+ "price",
+ "shipping",
+ "duty",
+ "priceBasis",
+ "delivered",
+ "currency",
+ "available",
+ "comparable",
+ "cheapest",
+ "mostKept",
+ "isYourSupplier",
+ "profit",
+ "versusYours",
+ "note",
+ "criticalDifferences",
+ "differencesUnresolved",
+ "pricingPlan",
+ "pricingPlanId",
+ "deliveryDaysMin",
+ "deliveryDaysMax",
+ "checkedAt",
+ "actionUrl",
+ "productUrl",
+ "affiliate",
+ "facts"
+ ],
+ "type": "object"
+ },
+ "otherOfferCount": {
+ "description": "How many other offers this supplier has, including any beyond otherOffers.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "otherOffers": {
+ "description": "This supplier's other products and print providers for the choice.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "actionUrl": {
+ "description": "The main link out to this offer: the supplier's product page, or its sign-up page when the affiliate programme pays only for sign-ups.",
+ "format": "uri",
+ "type": "string"
+ },
+ "affiliate": {
+ "description": "Whether actionUrl earns a commission; it never changes prices or rankings.",
+ "type": "boolean"
+ },
+ "available": {
+ "description": "The supplier sells this configuration and quotes it for the destination.",
+ "type": "boolean"
+ },
+ "buyerImportWarning": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A charge the buyer may pay on import, in words; null when there is none."
+ },
+ "cheapest": {
+ "description": "Has the lowest product plus shipping total among comparable offers; false when the comparison cannot rank suppliers.",
+ "type": "boolean"
+ },
+ "checkedAt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "When this price was last checked, as an ISO date-time; null when unknown."
+ },
+ "comparable": {
+ "description": "The priced configuration matches the requested choice closely enough to compare.",
+ "type": "boolean"
+ },
+ "criticalDifferences": {
+ "description": "Ways this product differs from the one asked about; empty for the same product.",
+ "items": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "currency": {
+ "anyOf": [
+ {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The currency these amounts are in; null when no price is known."
+ },
+ "delivered": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Product plus shipping in the response currency; null when the supplier cannot price it, never 0."
+ },
+ "deliveryDaysMax": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's longest stated delivery time, in days from order to arrival; null when unknown."
+ },
+ "deliveryDaysMin": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's shortest stated delivery time, in days from order to arrival; null when unknown."
+ },
+ "differencesUnresolved": {
+ "anyOf": [
+ {
+ "minLength": 1,
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A difference that could not be confirmed; null when everything is known."
+ },
+ "duty": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Supplier-billed duty in the response currency, separate from the delivered total; 0 when the supplier bills none, null when unverified."
+ },
+ "dutyEstimate": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "converted": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "currency": {
+ "description": "The currency of these duty amounts.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "max": {
+ "description": "Highest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "min": {
+ "description": "Lowest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "min",
+ "max",
+ "currency"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The same estimate in the response currency; null when it could not be converted."
+ },
+ "native": {
+ "additionalProperties": false,
+ "description": "The duty estimate in the supplier's own currency.",
+ "properties": {
+ "basis": {
+ "const": "line_net_x_compatible_product_rate",
+ "description": "How the estimate was derived: the line's net price times the supplier's per-product duty rate.",
+ "type": "string"
+ },
+ "currency": {
+ "description": "The currency of these duty amounts.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "max": {
+ "description": "Highest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "min": {
+ "description": "Lowest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "min",
+ "max",
+ "currency",
+ "basis"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "native",
+ "converted"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The bounded duty estimate when only a range is known; absent otherwise."
+ },
+ "dutyOutcome": {
+ "anyOf": [
+ {
+ "enum": [
+ "charged",
+ "not_applicable",
+ "estimated",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "charged when the supplier bills duty, not_applicable when none applies, estimated when only a range is known, unknown when unverified."
+ },
+ "dutySource": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The supplier's own duty amount, in its own currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "currency": {
+ "description": "The currency the supplier states that duty in.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's own duty charge as it states it; null when none is published."
+ },
+ "facts": {
+ "description": "Labelled facts about this offer, such as print method, size range and quantity.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "label": {
+ "description": "What the fact is about.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The fact's value.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "label",
+ "value"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "isYourSupplier": {
+ "description": "The supplier the seller said they use today.",
+ "type": "boolean"
+ },
+ "mostKept": {
+ "description": "Leaves the seller the most per sale; false unless profit is shown and every supplier-billed duty is known.",
+ "type": "boolean"
+ },
+ "note": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "How this offer's configuration differs from the one asked about, in words; null when there is nothing to add."
+ },
+ "price": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Product cost in the response currency, before shipping; null when unknown, never 0."
+ },
+ "priceBasis": {
+ "const": "product-and-shipping",
+ "description": "What the delivered total covers: product and shipping.",
+ "type": "string"
+ },
+ "pricingBasis": {
+ "description": "The selected price basis and any setup disclosure, in words.",
+ "type": "string"
+ },
+ "pricingContext": {
+ "additionalProperties": false,
+ "description": "Present when this price only holds under stated conditions, such as a design the seller already has.",
+ "properties": {
+ "basis": {
+ "description": "What the price assumes: an existing design the seller already has, or included digitisation.",
+ "enum": [
+ "existing-supplier-digitised-design",
+ "digitisation-included"
+ ],
+ "type": "string"
+ },
+ "newDesignSetup": {
+ "description": "How a new design's setup is charged, or that it is included.",
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "applicability": {
+ "description": "design-dependent when the fee depends on the artwork, selected when one fee applies to this order.",
+ "enum": [
+ "design-dependent",
+ "selected"
+ ],
+ "type": "string"
+ },
+ "application": {
+ "const": "not-modelled",
+ "description": "Always not-modelled: the charge is disclosed but never added to a total.",
+ "type": "string"
+ },
+ "fees": {
+ "description": "The setup fees the supplier lists.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The fee amount in its own currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "conditions": {
+ "description": "What must hold for this fee to apply.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "currency": {
+ "description": "Original supplier currency; never converted along with the unit price.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "What the fee is for: standard, text-only, image, adjustment, back-or-side or setup.",
+ "enum": [
+ "standard",
+ "text-only",
+ "image",
+ "adjustment",
+ "back-or-side",
+ "setup"
+ ],
+ "type": "string"
+ },
+ "scope": {
+ "description": "What the fee applies to: per design, per design and area, per order, per unit or unknown.",
+ "enum": [
+ "per-design",
+ "per-design-and-area",
+ "per-order",
+ "per-unit",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "source": {
+ "description": "What the supplier states about this fee.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "taxBasis": {
+ "description": "Whether the fee is quoted before VAT (ex-vat) or unclear.",
+ "enum": [
+ "ex-vat",
+ "unknown"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "amount",
+ "currency",
+ "taxBasis",
+ "scope",
+ "source",
+ "conditions"
+ ],
+ "type": "object"
+ },
+ "maxItems": 8,
+ "minItems": 1,
+ "type": "array"
+ },
+ "includedInDeliveredTotal": {
+ "const": false,
+ "description": "Always false: setup charges stay outside the delivered total.",
+ "type": "boolean"
+ },
+ "status": {
+ "const": "listed",
+ "description": "The supplier lists a setup charge.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "fees",
+ "applicability",
+ "application",
+ "includedInDeliveredTotal"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "conditions": {
+ "description": "What must hold for the inclusion.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "source": {
+ "description": "What the supplier states about the inclusion.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "status": {
+ "const": "included",
+ "description": "Digitisation is included, so there is no setup charge.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "source",
+ "conditions"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "reason": {
+ "description": "Why the setup charge is unknown.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "source": {
+ "description": "What the supplier states, when it says anything.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "status": {
+ "const": "unknown",
+ "description": "Whether a setup charge applies could not be established.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "reason"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ "physicalSelections": {
+ "description": "The supplier options this price was quoted for.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "axisId": {
+ "description": "The option field's id, such as size.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "axisLabel": {
+ "description": "The option field as shown, such as Size.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "kind": {
+ "description": "sku-option changes the unit price; standard-configuration is a fixed default.",
+ "enum": [
+ "sku-option",
+ "standard-configuration"
+ ],
+ "type": "string"
+ },
+ "valueId": {
+ "description": "The chosen value's id.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "valueLabel": {
+ "description": "The chosen value as shown, such as Adult M.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "axisId",
+ "valueId",
+ "axisLabel",
+ "valueLabel"
+ ],
+ "type": "object"
+ },
+ "maxItems": 8,
+ "type": "array"
+ },
+ "policyId": {
+ "description": "Which pricing policy this context follows.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "policyVersion": {
+ "description": "The version of that pricing policy.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "recurringConditions": {
+ "description": "What must remain true for this recurring unit price.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "source": {
+ "description": "What the supplier states about this price, in its own words.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "basis",
+ "policyId",
+ "policyVersion",
+ "source",
+ "recurringConditions",
+ "newDesignSetup",
+ "physicalSelections"
+ ],
+ "type": "object"
+ },
+ "pricingPlan": {
+ "description": "The supplier plan this price uses, such as Standard pricing.",
+ "type": "string"
+ },
+ "pricingPlanId": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The stable id of that plan, such as `printify:premium`; pass it back instead of guessing from its name. Null when no price is known."
+ },
+ "product": {
+ "description": "The supplier's own name for the product.",
+ "type": "string"
+ },
+ "productUrl": {
+ "description": "The supplier's page for this product and configuration.",
+ "format": "uri",
+ "type": "string"
+ },
+ "profit": {
+ "anyOf": [
+ {
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "dutyStatus": {
+ "description": "How well the supplier-billed duty is established: known, estimated from bounded quotes, or unknown.",
+ "enum": [
+ "known",
+ "estimated",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "estimatedDutyDeducted": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The estimated duty deducted from the sale; null when duty is known or was not deducted."
+ },
+ "feeBreakdown": {
+ "description": "Each platform fee and its amount.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The fee amount in the response currency.",
+ "type": "number"
+ },
+ "label": {
+ "description": "The fee's name, such as transaction fee.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "label",
+ "amount"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees": {
+ "description": "Platform fees for this sale in the response currency.",
+ "type": "number"
+ },
+ "keep": {
+ "description": "What the seller keeps per sale before tax, in the response currency.",
+ "type": "number"
+ },
+ "margin": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Share of the sale the seller keeps, 0 to 1; null when the sale is zero."
+ },
+ "qualification": {
+ "description": "In words, whether supplier-billed duty is included in or left out of this profit.",
+ "type": "string"
+ },
+ "sale": {
+ "description": "The selling price in the response currency; with targetMargin, the price to charge.",
+ "type": "number"
+ },
+ "status": {
+ "const": "calculated",
+ "description": "Profit could be worked out for this offer.",
+ "type": "string"
+ },
+ "supplierCost": {
+ "description": "What the supplier charges in the response currency: product, shipping and any known duty.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "status",
+ "dutyStatus",
+ "qualification",
+ "sale",
+ "supplierCost",
+ "fees",
+ "feeBreakdown",
+ "keep",
+ "margin"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "reason": {
+ "description": "Why: the supplier cost is unknown, the platform fees are unavailable, or the target margin cannot be reached.",
+ "enum": [
+ "missing_cost",
+ "fees_unavailable",
+ "target_not_reachable"
+ ],
+ "type": "string"
+ },
+ "status": {
+ "const": "unavailable",
+ "description": "Profit could not be worked out for this offer.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "reason"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "This offer's profit when a selling price or target margin was given; null otherwise."
+ },
+ "provider": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The print provider that makes the order, for a marketplace; null for a direct supplier."
+ },
+ "shipping": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Shipping cost in the response currency; null when unknown, never 0."
+ },
+ "sourceCurrency": {
+ "anyOf": [
+ {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The currency the supplier quoted its price in, before conversion to the response currency; null when no quote exists."
+ },
+ "supplier": {
+ "description": "The supplier's name.",
+ "type": "string"
+ },
+ "supplierId": {
+ "description": "The supplier's id.",
+ "type": "string"
+ },
+ "taxNote": {
+ "description": "How VAT or sales tax applies to this price, in words.",
+ "type": "string"
+ },
+ "versusYours": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Per sale against the seller's own supplier: positive means the seller keeps more here. Uses profit when shown, otherwise the delivered total; null when the two cannot be compared."
+ }
+ },
+ "required": [
+ "supplierId",
+ "supplier",
+ "provider",
+ "product",
+ "price",
+ "shipping",
+ "duty",
+ "priceBasis",
+ "delivered",
+ "currency",
+ "available",
+ "comparable",
+ "cheapest",
+ "mostKept",
+ "isYourSupplier",
+ "profit",
+ "versusYours",
+ "note",
+ "criticalDifferences",
+ "differencesUnresolved",
+ "pricingPlan",
+ "pricingPlanId",
+ "deliveryDaysMin",
+ "deliveryDaysMax",
+ "checkedAt",
+ "actionUrl",
+ "productUrl",
+ "affiliate",
+ "facts"
+ ],
+ "type": "object"
+ },
+ "maxItems": 50,
+ "type": "array"
+ }
+ },
+ "required": [
+ "offer",
+ "otherOffers",
+ "otherOfferCount"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "currency": {
+ "description": "Currency for every price, such as USD, GBP or EUR.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "destination": {
+ "description": "The buyer's country these prices are for.",
+ "enum": [
+ "US",
+ "GB",
+ "DE",
+ "AU",
+ "CA"
+ ],
+ "type": "string"
+ },
+ "ok": {
+ "const": true,
+ "type": "boolean"
+ },
+ "optionChoices": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The selected option by field, such as { size: \"Adult M\", color: \"Black\" }.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "optionCount": {
+ "description": "How many configurations the product supports in total, before the 100 listed in options.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "optionKey": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The configuration compared, from the product's options; null when the product has none."
+ },
+ "optionLabel": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "That configuration in words, such as `Adult M / Black`; null when the product has none."
+ },
+ "options": {
+ "description": "Up to 100 configurations the product supports, to pass as optionKey.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "key": {
+ "description": "The configuration's key, to pass as optionKey.",
+ "type": "string"
+ },
+ "label": {
+ "description": "The configuration in words, such as `Adult M / Black`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "key",
+ "label"
+ ],
+ "type": "object"
+ },
+ "maxItems": 100,
+ "type": "array"
+ },
+ "priceContext": {
+ "description": "What the prices cover and which option they reflect, in words.",
+ "type": "string"
+ },
+ "pricingTier": {
+ "description": "The supplier plan the prices come from: base is standard, tier1 and tier2 are paid plans.",
+ "enum": [
+ "base",
+ "tier1",
+ "tier2"
+ ],
+ "type": "string"
+ },
+ "product": {
+ "additionalProperties": false,
+ "description": "The product that was compared.",
+ "properties": {
+ "category": {
+ "description": "The category slug from the product's path, such as `t-shirts`.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The product's id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The product's name.",
+ "type": "string"
+ },
+ "subtitle": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A short qualifier under the name; null when there is none."
+ },
+ "url": {
+ "description": "The product's comparison page with these choices applied.",
+ "format": "uri",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "subtitle",
+ "category",
+ "url"
+ ],
+ "type": "object"
+ },
+ "profit": {
+ "description": "Whether profit is shown, and the selling price or target margin it uses.",
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "status": {
+ "const": "off",
+ "description": "No selling price or target margin was given, so profit is not calculated.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "message": {
+ "description": "What to ask the seller, in words.",
+ "type": "string"
+ },
+ "missing": {
+ "description": "What to ask the seller for.",
+ "items": {
+ "enum": [
+ "salesChannel",
+ "shopLocation"
+ ],
+ "type": "string"
+ },
+ "minItems": 1,
+ "type": "array"
+ },
+ "status": {
+ "const": "needs_input",
+ "description": "Profit needs the sales channel or the shop country before it can be calculated.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "missing",
+ "message"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "message": {
+ "description": "Why profit is unavailable, in words.",
+ "type": "string"
+ },
+ "status": {
+ "const": "unavailable",
+ "description": "Profit cannot be calculated for this comparison.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "message"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "fallbackFromLabel": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Set when the requested channel has no fees for the shop, so another was used."
+ },
+ "feesCheckedAt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The date of the fee research in use, as `YYYY-MM-DD`; null when unknown."
+ },
+ "mode": {
+ "description": "selling-price uses the price the seller gave; target-margin returns the price to charge.",
+ "enum": [
+ "selling-price",
+ "target-margin"
+ ],
+ "type": "string"
+ },
+ "salesChannel": {
+ "description": "The sales channel whose platform fees apply.",
+ "enum": [
+ "etsy",
+ "shopify",
+ "woocommerce",
+ "tiktok-shop"
+ ],
+ "type": "string"
+ },
+ "salesChannelLabel": {
+ "description": "That sales channel as a person would say it.",
+ "type": "string"
+ },
+ "sellingPrice": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The selling price given, in the response currency; null with targetMargin."
+ },
+ "shopLocation": {
+ "description": "The country the seller's shop is based in, which sets the fees.",
+ "enum": [
+ "US",
+ "GB",
+ "DE",
+ "AU",
+ "CA"
+ ],
+ "type": "string"
+ },
+ "status": {
+ "const": "ready",
+ "description": "Profit is calculated for every offer whose supplier cost is complete.",
+ "type": "string"
+ },
+ "targetMargin": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The target margin in percent; null with sellingPrice."
+ }
+ },
+ "required": [
+ "status",
+ "mode",
+ "sellingPrice",
+ "targetMargin",
+ "salesChannel",
+ "salesChannelLabel",
+ "shopLocation",
+ "fallbackFromLabel",
+ "feesCheckedAt"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ "servedAt": {
+ "description": "When this comparison's data was read, as an ISO date-time.",
+ "type": "string"
+ },
+ "supplier": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The supplier's id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The supplier's name.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Set when the request asked for one supplier's offers."
+ },
+ "suppliers": {
+ "description": "One entry per supplier, the seller's own pinned first when given, then most profit first when profit is shown.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "offer": {
+ "additionalProperties": false,
+ "description": "The offer this supplier's row shows.",
+ "properties": {
+ "actionUrl": {
+ "description": "The main link out to this offer: the supplier's product page, or its sign-up page when the affiliate programme pays only for sign-ups.",
+ "format": "uri",
+ "type": "string"
+ },
+ "affiliate": {
+ "description": "Whether actionUrl earns a commission; it never changes prices or rankings.",
+ "type": "boolean"
+ },
+ "available": {
+ "description": "The supplier sells this configuration and quotes it for the destination.",
+ "type": "boolean"
+ },
+ "buyerImportWarning": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A charge the buyer may pay on import, in words; null when there is none."
+ },
+ "cheapest": {
+ "description": "Has the lowest product plus shipping total among comparable offers; false when the comparison cannot rank suppliers.",
+ "type": "boolean"
+ },
+ "checkedAt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "When this price was last checked, as an ISO date-time; null when unknown."
+ },
+ "comparable": {
+ "description": "The priced configuration matches the requested choice closely enough to compare.",
+ "type": "boolean"
+ },
+ "criticalDifferences": {
+ "description": "Ways this product differs from the one asked about; empty for the same product.",
+ "items": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "currency": {
+ "anyOf": [
+ {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The currency these amounts are in; null when no price is known."
+ },
+ "delivered": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Product plus shipping in the response currency; null when the supplier cannot price it, never 0."
+ },
+ "deliveryDaysMax": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's longest stated delivery time, in days from order to arrival; null when unknown."
+ },
+ "deliveryDaysMin": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's shortest stated delivery time, in days from order to arrival; null when unknown."
+ },
+ "differencesUnresolved": {
+ "anyOf": [
+ {
+ "minLength": 1,
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A difference that could not be confirmed; null when everything is known."
+ },
+ "duty": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Supplier-billed duty in the response currency, separate from the delivered total; 0 when the supplier bills none, null when unverified."
+ },
+ "dutyEstimate": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "converted": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "currency": {
+ "description": "The currency of these duty amounts.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "max": {
+ "description": "Highest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "min": {
+ "description": "Lowest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "min",
+ "max",
+ "currency"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The same estimate in the response currency; null when it could not be converted."
+ },
+ "native": {
+ "additionalProperties": false,
+ "description": "The duty estimate in the supplier's own currency.",
+ "properties": {
+ "basis": {
+ "const": "line_net_x_compatible_product_rate",
+ "description": "How the estimate was derived: the line's net price times the supplier's per-product duty rate.",
+ "type": "string"
+ },
+ "currency": {
+ "description": "The currency of these duty amounts.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "max": {
+ "description": "Highest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "min": {
+ "description": "Lowest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "min",
+ "max",
+ "currency",
+ "basis"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "native",
+ "converted"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The bounded duty estimate when only a range is known; absent otherwise."
+ },
+ "dutyOutcome": {
+ "anyOf": [
+ {
+ "enum": [
+ "charged",
+ "not_applicable",
+ "estimated",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "charged when the supplier bills duty, not_applicable when none applies, estimated when only a range is known, unknown when unverified."
+ },
+ "dutySource": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The supplier's own duty amount, in its own currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "currency": {
+ "description": "The currency the supplier states that duty in.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's own duty charge as it states it; null when none is published."
+ },
+ "facts": {
+ "description": "Labelled facts about this offer, such as print method, size range and quantity.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "label": {
+ "description": "What the fact is about.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The fact's value.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "label",
+ "value"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "isYourSupplier": {
+ "description": "The supplier the seller said they use today.",
+ "type": "boolean"
+ },
+ "mostKept": {
+ "description": "Leaves the seller the most per sale; false unless profit is shown and every supplier-billed duty is known.",
+ "type": "boolean"
+ },
+ "note": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "How this offer's configuration differs from the one asked about, in words; null when there is nothing to add."
+ },
+ "price": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Product cost in the response currency, before shipping; null when unknown, never 0."
+ },
+ "priceBasis": {
+ "const": "product-and-shipping",
+ "description": "What the delivered total covers: product and shipping.",
+ "type": "string"
+ },
+ "pricingBasis": {
+ "description": "The selected price basis and any setup disclosure, in words.",
+ "type": "string"
+ },
+ "pricingContext": {
+ "additionalProperties": false,
+ "description": "Present when this price only holds under stated conditions, such as a design the seller already has.",
+ "properties": {
+ "basis": {
+ "description": "What the price assumes: an existing design the seller already has, or included digitisation.",
+ "enum": [
+ "existing-supplier-digitised-design",
+ "digitisation-included"
+ ],
+ "type": "string"
+ },
+ "newDesignSetup": {
+ "description": "How a new design's setup is charged, or that it is included.",
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "applicability": {
+ "description": "design-dependent when the fee depends on the artwork, selected when one fee applies to this order.",
+ "enum": [
+ "design-dependent",
+ "selected"
+ ],
+ "type": "string"
+ },
+ "application": {
+ "const": "not-modelled",
+ "description": "Always not-modelled: the charge is disclosed but never added to a total.",
+ "type": "string"
+ },
+ "fees": {
+ "description": "The setup fees the supplier lists.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The fee amount in its own currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "conditions": {
+ "description": "What must hold for this fee to apply.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "currency": {
+ "description": "Original supplier currency; never converted along with the unit price.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "What the fee is for: standard, text-only, image, adjustment, back-or-side or setup.",
+ "enum": [
+ "standard",
+ "text-only",
+ "image",
+ "adjustment",
+ "back-or-side",
+ "setup"
+ ],
+ "type": "string"
+ },
+ "scope": {
+ "description": "What the fee applies to: per design, per design and area, per order, per unit or unknown.",
+ "enum": [
+ "per-design",
+ "per-design-and-area",
+ "per-order",
+ "per-unit",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "source": {
+ "description": "What the supplier states about this fee.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "taxBasis": {
+ "description": "Whether the fee is quoted before VAT (ex-vat) or unclear.",
+ "enum": [
+ "ex-vat",
+ "unknown"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "amount",
+ "currency",
+ "taxBasis",
+ "scope",
+ "source",
+ "conditions"
+ ],
+ "type": "object"
+ },
+ "maxItems": 8,
+ "minItems": 1,
+ "type": "array"
+ },
+ "includedInDeliveredTotal": {
+ "const": false,
+ "description": "Always false: setup charges stay outside the delivered total.",
+ "type": "boolean"
+ },
+ "status": {
+ "const": "listed",
+ "description": "The supplier lists a setup charge.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "fees",
+ "applicability",
+ "application",
+ "includedInDeliveredTotal"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "conditions": {
+ "description": "What must hold for the inclusion.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "source": {
+ "description": "What the supplier states about the inclusion.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "status": {
+ "const": "included",
+ "description": "Digitisation is included, so there is no setup charge.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "source",
+ "conditions"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "reason": {
+ "description": "Why the setup charge is unknown.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "source": {
+ "description": "What the supplier states, when it says anything.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "status": {
+ "const": "unknown",
+ "description": "Whether a setup charge applies could not be established.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "reason"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ "physicalSelections": {
+ "description": "The supplier options this price was quoted for.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "axisId": {
+ "description": "The option field's id, such as size.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "axisLabel": {
+ "description": "The option field as shown, such as Size.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "kind": {
+ "description": "sku-option changes the unit price; standard-configuration is a fixed default.",
+ "enum": [
+ "sku-option",
+ "standard-configuration"
+ ],
+ "type": "string"
+ },
+ "valueId": {
+ "description": "The chosen value's id.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "valueLabel": {
+ "description": "The chosen value as shown, such as Adult M.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "axisId",
+ "valueId",
+ "axisLabel",
+ "valueLabel"
+ ],
+ "type": "object"
+ },
+ "maxItems": 8,
+ "type": "array"
+ },
+ "policyId": {
+ "description": "Which pricing policy this context follows.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "policyVersion": {
+ "description": "The version of that pricing policy.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "recurringConditions": {
+ "description": "What must remain true for this recurring unit price.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "source": {
+ "description": "What the supplier states about this price, in its own words.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "basis",
+ "policyId",
+ "policyVersion",
+ "source",
+ "recurringConditions",
+ "newDesignSetup",
+ "physicalSelections"
+ ],
+ "type": "object"
+ },
+ "pricingPlan": {
+ "description": "The supplier plan this price uses, such as Standard pricing.",
+ "type": "string"
+ },
+ "pricingPlanId": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The stable id of that plan, such as `printify:premium`; pass it back instead of guessing from its name. Null when no price is known."
+ },
+ "product": {
+ "description": "The supplier's own name for the product.",
+ "type": "string"
+ },
+ "productUrl": {
+ "description": "The supplier's page for this product and configuration.",
+ "format": "uri",
+ "type": "string"
+ },
+ "profit": {
+ "anyOf": [
+ {
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "dutyStatus": {
+ "description": "How well the supplier-billed duty is established: known, estimated from bounded quotes, or unknown.",
+ "enum": [
+ "known",
+ "estimated",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "estimatedDutyDeducted": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The estimated duty deducted from the sale; null when duty is known or was not deducted."
+ },
+ "feeBreakdown": {
+ "description": "Each platform fee and its amount.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The fee amount in the response currency.",
+ "type": "number"
+ },
+ "label": {
+ "description": "The fee's name, such as transaction fee.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "label",
+ "amount"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees": {
+ "description": "Platform fees for this sale in the response currency.",
+ "type": "number"
+ },
+ "keep": {
+ "description": "What the seller keeps per sale before tax, in the response currency.",
+ "type": "number"
+ },
+ "margin": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Share of the sale the seller keeps, 0 to 1; null when the sale is zero."
+ },
+ "qualification": {
+ "description": "In words, whether supplier-billed duty is included in or left out of this profit.",
+ "type": "string"
+ },
+ "sale": {
+ "description": "The selling price in the response currency; with targetMargin, the price to charge.",
+ "type": "number"
+ },
+ "status": {
+ "const": "calculated",
+ "description": "Profit could be worked out for this offer.",
+ "type": "string"
+ },
+ "supplierCost": {
+ "description": "What the supplier charges in the response currency: product, shipping and any known duty.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "status",
+ "dutyStatus",
+ "qualification",
+ "sale",
+ "supplierCost",
+ "fees",
+ "feeBreakdown",
+ "keep",
+ "margin"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "reason": {
+ "description": "Why: the supplier cost is unknown, the platform fees are unavailable, or the target margin cannot be reached.",
+ "enum": [
+ "missing_cost",
+ "fees_unavailable",
+ "target_not_reachable"
+ ],
+ "type": "string"
+ },
+ "status": {
+ "const": "unavailable",
+ "description": "Profit could not be worked out for this offer.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "reason"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "This offer's profit when a selling price or target margin was given; null otherwise."
+ },
+ "provider": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The print provider that makes the order, for a marketplace; null for a direct supplier."
+ },
+ "shipping": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Shipping cost in the response currency; null when unknown, never 0."
+ },
+ "sourceCurrency": {
+ "anyOf": [
+ {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The currency the supplier quoted its price in, before conversion to the response currency; null when no quote exists."
+ },
+ "supplier": {
+ "description": "The supplier's name.",
+ "type": "string"
+ },
+ "supplierId": {
+ "description": "The supplier's id.",
+ "type": "string"
+ },
+ "taxNote": {
+ "description": "How VAT or sales tax applies to this price, in words.",
+ "type": "string"
+ },
+ "versusYours": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Per sale against the seller's own supplier: positive means the seller keeps more here. Uses profit when shown, otherwise the delivered total; null when the two cannot be compared."
+ }
+ },
+ "required": [
+ "supplierId",
+ "supplier",
+ "provider",
+ "product",
+ "price",
+ "shipping",
+ "duty",
+ "priceBasis",
+ "delivered",
+ "currency",
+ "available",
+ "comparable",
+ "cheapest",
+ "mostKept",
+ "isYourSupplier",
+ "profit",
+ "versusYours",
+ "note",
+ "criticalDifferences",
+ "differencesUnresolved",
+ "pricingPlan",
+ "pricingPlanId",
+ "deliveryDaysMin",
+ "deliveryDaysMax",
+ "checkedAt",
+ "actionUrl",
+ "productUrl",
+ "affiliate",
+ "facts"
+ ],
+ "type": "object"
+ },
+ "otherOfferCount": {
+ "description": "How many other offers this supplier has, including any beyond otherOffers.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "otherOffers": {
+ "description": "This supplier's other products and print providers for the choice.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "actionUrl": {
+ "description": "The main link out to this offer: the supplier's product page, or its sign-up page when the affiliate programme pays only for sign-ups.",
+ "format": "uri",
+ "type": "string"
+ },
+ "affiliate": {
+ "description": "Whether actionUrl earns a commission; it never changes prices or rankings.",
+ "type": "boolean"
+ },
+ "available": {
+ "description": "The supplier sells this configuration and quotes it for the destination.",
+ "type": "boolean"
+ },
+ "buyerImportWarning": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A charge the buyer may pay on import, in words; null when there is none."
+ },
+ "cheapest": {
+ "description": "Has the lowest product plus shipping total among comparable offers; false when the comparison cannot rank suppliers.",
+ "type": "boolean"
+ },
+ "checkedAt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "When this price was last checked, as an ISO date-time; null when unknown."
+ },
+ "comparable": {
+ "description": "The priced configuration matches the requested choice closely enough to compare.",
+ "type": "boolean"
+ },
+ "criticalDifferences": {
+ "description": "Ways this product differs from the one asked about; empty for the same product.",
+ "items": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "currency": {
+ "anyOf": [
+ {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The currency these amounts are in; null when no price is known."
+ },
+ "delivered": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Product plus shipping in the response currency; null when the supplier cannot price it, never 0."
+ },
+ "deliveryDaysMax": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's longest stated delivery time, in days from order to arrival; null when unknown."
+ },
+ "deliveryDaysMin": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's shortest stated delivery time, in days from order to arrival; null when unknown."
+ },
+ "differencesUnresolved": {
+ "anyOf": [
+ {
+ "minLength": 1,
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A difference that could not be confirmed; null when everything is known."
+ },
+ "duty": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Supplier-billed duty in the response currency, separate from the delivered total; 0 when the supplier bills none, null when unverified."
+ },
+ "dutyEstimate": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "converted": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "currency": {
+ "description": "The currency of these duty amounts.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "max": {
+ "description": "Highest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "min": {
+ "description": "Lowest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "min",
+ "max",
+ "currency"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The same estimate in the response currency; null when it could not be converted."
+ },
+ "native": {
+ "additionalProperties": false,
+ "description": "The duty estimate in the supplier's own currency.",
+ "properties": {
+ "basis": {
+ "const": "line_net_x_compatible_product_rate",
+ "description": "How the estimate was derived: the line's net price times the supplier's per-product duty rate.",
+ "type": "string"
+ },
+ "currency": {
+ "description": "The currency of these duty amounts.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "max": {
+ "description": "Highest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "min": {
+ "description": "Lowest amount in this duty range, in this currency.",
+ "minimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "min",
+ "max",
+ "currency",
+ "basis"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "native",
+ "converted"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The bounded duty estimate when only a range is known; absent otherwise."
+ },
+ "dutyOutcome": {
+ "anyOf": [
+ {
+ "enum": [
+ "charged",
+ "not_applicable",
+ "estimated",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "charged when the supplier bills duty, not_applicable when none applies, estimated when only a range is known, unknown when unverified."
+ },
+ "dutySource": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The supplier's own duty amount, in its own currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "currency": {
+ "description": "The currency the supplier states that duty in.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier's own duty charge as it states it; null when none is published."
+ },
+ "facts": {
+ "description": "Labelled facts about this offer, such as print method, size range and quantity.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "label": {
+ "description": "What the fact is about.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The fact's value.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "label",
+ "value"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "isYourSupplier": {
+ "description": "The supplier the seller said they use today.",
+ "type": "boolean"
+ },
+ "mostKept": {
+ "description": "Leaves the seller the most per sale; false unless profit is shown and every supplier-billed duty is known.",
+ "type": "boolean"
+ },
+ "note": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "How this offer's configuration differs from the one asked about, in words; null when there is nothing to add."
+ },
+ "price": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Product cost in the response currency, before shipping; null when unknown, never 0."
+ },
+ "priceBasis": {
+ "const": "product-and-shipping",
+ "description": "What the delivered total covers: product and shipping.",
+ "type": "string"
+ },
+ "pricingBasis": {
+ "description": "The selected price basis and any setup disclosure, in words.",
+ "type": "string"
+ },
+ "pricingContext": {
+ "additionalProperties": false,
+ "description": "Present when this price only holds under stated conditions, such as a design the seller already has.",
+ "properties": {
+ "basis": {
+ "description": "What the price assumes: an existing design the seller already has, or included digitisation.",
+ "enum": [
+ "existing-supplier-digitised-design",
+ "digitisation-included"
+ ],
+ "type": "string"
+ },
+ "newDesignSetup": {
+ "description": "How a new design's setup is charged, or that it is included.",
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "applicability": {
+ "description": "design-dependent when the fee depends on the artwork, selected when one fee applies to this order.",
+ "enum": [
+ "design-dependent",
+ "selected"
+ ],
+ "type": "string"
+ },
+ "application": {
+ "const": "not-modelled",
+ "description": "Always not-modelled: the charge is disclosed but never added to a total.",
+ "type": "string"
+ },
+ "fees": {
+ "description": "The setup fees the supplier lists.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The fee amount in its own currency.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "conditions": {
+ "description": "What must hold for this fee to apply.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "currency": {
+ "description": "Original supplier currency; never converted along with the unit price.",
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "What the fee is for: standard, text-only, image, adjustment, back-or-side or setup.",
+ "enum": [
+ "standard",
+ "text-only",
+ "image",
+ "adjustment",
+ "back-or-side",
+ "setup"
+ ],
+ "type": "string"
+ },
+ "scope": {
+ "description": "What the fee applies to: per design, per design and area, per order, per unit or unknown.",
+ "enum": [
+ "per-design",
+ "per-design-and-area",
+ "per-order",
+ "per-unit",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "source": {
+ "description": "What the supplier states about this fee.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "taxBasis": {
+ "description": "Whether the fee is quoted before VAT (ex-vat) or unclear.",
+ "enum": [
+ "ex-vat",
+ "unknown"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "amount",
+ "currency",
+ "taxBasis",
+ "scope",
+ "source",
+ "conditions"
+ ],
+ "type": "object"
+ },
+ "maxItems": 8,
+ "minItems": 1,
+ "type": "array"
+ },
+ "includedInDeliveredTotal": {
+ "const": false,
+ "description": "Always false: setup charges stay outside the delivered total.",
+ "type": "boolean"
+ },
+ "status": {
+ "const": "listed",
+ "description": "The supplier lists a setup charge.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "fees",
+ "applicability",
+ "application",
+ "includedInDeliveredTotal"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "conditions": {
+ "description": "What must hold for the inclusion.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "source": {
+ "description": "What the supplier states about the inclusion.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "status": {
+ "const": "included",
+ "description": "Digitisation is included, so there is no setup charge.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "source",
+ "conditions"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "reason": {
+ "description": "Why the setup charge is unknown.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "source": {
+ "description": "What the supplier states, when it says anything.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "status": {
+ "const": "unknown",
+ "description": "Whether a setup charge applies could not be established.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "reason"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ "physicalSelections": {
+ "description": "The supplier options this price was quoted for.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "axisId": {
+ "description": "The option field's id, such as size.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "axisLabel": {
+ "description": "The option field as shown, such as Size.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "kind": {
+ "description": "sku-option changes the unit price; standard-configuration is a fixed default.",
+ "enum": [
+ "sku-option",
+ "standard-configuration"
+ ],
+ "type": "string"
+ },
+ "valueId": {
+ "description": "The chosen value's id.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "valueLabel": {
+ "description": "The chosen value as shown, such as Adult M.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "axisId",
+ "valueId",
+ "axisLabel",
+ "valueLabel"
+ ],
+ "type": "object"
+ },
+ "maxItems": 8,
+ "type": "array"
+ },
+ "policyId": {
+ "description": "Which pricing policy this context follows.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "policyVersion": {
+ "description": "The version of that pricing policy.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "recurringConditions": {
+ "description": "What must remain true for this recurring unit price.",
+ "items": {
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ },
+ "maxItems": 12,
+ "type": "array"
+ },
+ "source": {
+ "description": "What the supplier states about this price, in its own words.",
+ "maxLength": 600,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "basis",
+ "policyId",
+ "policyVersion",
+ "source",
+ "recurringConditions",
+ "newDesignSetup",
+ "physicalSelections"
+ ],
+ "type": "object"
+ },
+ "pricingPlan": {
+ "description": "The supplier plan this price uses, such as Standard pricing.",
+ "type": "string"
+ },
+ "pricingPlanId": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The stable id of that plan, such as `printify:premium`; pass it back instead of guessing from its name. Null when no price is known."
+ },
+ "product": {
+ "description": "The supplier's own name for the product.",
+ "type": "string"
+ },
+ "productUrl": {
+ "description": "The supplier's page for this product and configuration.",
+ "format": "uri",
+ "type": "string"
+ },
+ "profit": {
+ "anyOf": [
+ {
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "dutyStatus": {
+ "description": "How well the supplier-billed duty is established: known, estimated from bounded quotes, or unknown.",
+ "enum": [
+ "known",
+ "estimated",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "estimatedDutyDeducted": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The estimated duty deducted from the sale; null when duty is known or was not deducted."
+ },
+ "feeBreakdown": {
+ "description": "Each platform fee and its amount.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The fee amount in the response currency.",
+ "type": "number"
+ },
+ "label": {
+ "description": "The fee's name, such as transaction fee.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "label",
+ "amount"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees": {
+ "description": "Platform fees for this sale in the response currency.",
+ "type": "number"
+ },
+ "keep": {
+ "description": "What the seller keeps per sale before tax, in the response currency.",
+ "type": "number"
+ },
+ "margin": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Share of the sale the seller keeps, 0 to 1; null when the sale is zero."
+ },
+ "qualification": {
+ "description": "In words, whether supplier-billed duty is included in or left out of this profit.",
+ "type": "string"
+ },
+ "sale": {
+ "description": "The selling price in the response currency; with targetMargin, the price to charge.",
+ "type": "number"
+ },
+ "status": {
+ "const": "calculated",
+ "description": "Profit could be worked out for this offer.",
+ "type": "string"
+ },
+ "supplierCost": {
+ "description": "What the supplier charges in the response currency: product, shipping and any known duty.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "status",
+ "dutyStatus",
+ "qualification",
+ "sale",
+ "supplierCost",
+ "fees",
+ "feeBreakdown",
+ "keep",
+ "margin"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "reason": {
+ "description": "Why: the supplier cost is unknown, the platform fees are unavailable, or the target margin cannot be reached.",
+ "enum": [
+ "missing_cost",
+ "fees_unavailable",
+ "target_not_reachable"
+ ],
+ "type": "string"
+ },
+ "status": {
+ "const": "unavailable",
+ "description": "Profit could not be worked out for this offer.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "reason"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "This offer's profit when a selling price or target margin was given; null otherwise."
+ },
+ "provider": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The print provider that makes the order, for a marketplace; null for a direct supplier."
+ },
+ "shipping": {
+ "anyOf": [
+ {
+ "minimum": 0,
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Shipping cost in the response currency; null when unknown, never 0."
+ },
+ "sourceCurrency": {
+ "anyOf": [
+ {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "AUD",
+ "CAD"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The currency the supplier quoted its price in, before conversion to the response currency; null when no quote exists."
+ },
+ "supplier": {
+ "description": "The supplier's name.",
+ "type": "string"
+ },
+ "supplierId": {
+ "description": "The supplier's id.",
+ "type": "string"
+ },
+ "taxNote": {
+ "description": "How VAT or sales tax applies to this price, in words.",
+ "type": "string"
+ },
+ "versusYours": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Per sale against the seller's own supplier: positive means the seller keeps more here. Uses profit when shown, otherwise the delivered total; null when the two cannot be compared."
+ }
+ },
+ "required": [
+ "supplierId",
+ "supplier",
+ "provider",
+ "product",
+ "price",
+ "shipping",
+ "duty",
+ "priceBasis",
+ "delivered",
+ "currency",
+ "available",
+ "comparable",
+ "cheapest",
+ "mostKept",
+ "isYourSupplier",
+ "profit",
+ "versusYours",
+ "note",
+ "criticalDifferences",
+ "differencesUnresolved",
+ "pricingPlan",
+ "pricingPlanId",
+ "deliveryDaysMin",
+ "deliveryDaysMax",
+ "checkedAt",
+ "actionUrl",
+ "productUrl",
+ "affiliate",
+ "facts"
+ ],
+ "type": "object"
+ },
+ "maxItems": 50,
+ "type": "array"
+ }
+ },
+ "required": [
+ "offer",
+ "otherOffers",
+ "otherOfferCount"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "yourSupplier": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The supplier's id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The supplier's name.",
+ "type": "string"
+ },
+ "sellsProduct": {
+ "description": "False when the supplier does not sell this product in this configuration.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "sellsProduct"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The supplier the seller said they use; null when they did not say."
+ }
+ },
+ "required": [
+ "ok",
+ "product",
+ "destination",
+ "currency",
+ "pricingTier",
+ "optionKey",
+ "optionLabel",
+ "optionChoices",
+ "profit",
+ "yourSupplier",
+ "supplier",
+ "options",
+ "optionCount",
+ "suppliers",
+ "alternatives",
+ "priceContext",
+ "servedAt",
+ "affiliateDisclosure"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "error": {
+ "additionalProperties": false,
+ "description": "The error this call returned instead of a result.",
+ "properties": {
+ "code": {
+ "description": "The machine-readable reason the call failed.",
+ "enum": [
+ "invalid_input",
+ "not_found",
+ "product_not_found",
+ "invalid_option",
+ "comparison_unavailable",
+ "unavailable",
+ "rate_limited"
+ ],
+ "type": "string"
+ },
+ "message": {
+ "description": "What went wrong, in words, and what to do next.",
+ "type": "string"
+ },
+ "retryable": {
+ "description": "Whether calling again could succeed.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "code",
+ "message",
+ "retryable"
+ ],
+ "type": "object"
+ },
+ "ok": {
+ "const": false,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "ok",
+ "error"
+ ],
+ "type": "object"
+ }
+]