SupplierQuote response model

All models · Download OpenAPI

Nullable fields represent unknown values; they do not imply zero cost or a completed action.

Field	Type	Required	Details
id	string	Yes	Format: uuid
version	integer	Yes	Versions are per invitation. A revision adds a row; it never replaces the earlier one.
status	string	Yes	One of: submitted, revised, accepted, declined
provenance	object	Yes
provenance.source	“supplier_portal_submission”	If parent supplied
provenance.modelExtracted	false	If parent supplied
provenance.submittedAt	string or null	If parent supplied
provenance.submittedByUserId	string or null	If parent supplied
provenance.quoteReference	string or null	If parent supplied
provenance.quoteDate	string or null	If parent supplied
answersRevision	integer or null	Yes
supersededByRevision	integer or null	Yes
commercial	object	Yes
commercial.currency	string	If parent supplied	Currency of the quoted prices.. One of: USD, CNY
commercial.currencyAtColumnDefault	boolean	If parent supplied	True when the stored value is still USD, the column default, so it cannot be read as a currency the supplier declared.
commercial.incoterm	string	If parent supplied	One of: EXW, FCA, CPT, CIP, DAP, DPU, DDP, FAS, FOB, CFR, CIF
commercial.incotermAtColumnDefault	boolean	If parent supplied	True when the stored value is still EXW, the column default, so it cannot be read as a trade term the supplier declared.
commercial.namedPlace	string or null	If parent supplied
commercial.priceBreaks	object[]	If parent supplied	Quantity breaks exactly as submitted. Empty when the supplier quoted no unit price.
commercial.priceBreaks[].quantity	number	If parent supplied
commercial.priceBreaks[].unitPrice	number	If parent supplied
commercial.quoteUnit	string	If parent supplied	What one unit of priceBreaks.unitPrice buys.. One of: piece, set, unknown
commercial.taxIncluded	string	If parent supplied	Whether the quoted price includes tax.. One of: included, excluded, unknown
commercial.moq	integer or null	If parent supplied
commercial.moqDriver	string or null	If parent supplied
commercial.toolingCost	string or null	If parent supplied
commercial.toolingType	string	If parent supplied	What tooling the price assumes.. One of: none, rapid_aluminum, steel_bridge, production_steel, other
commercial.toolingShotLife	integer or null	If parent supplied
commercial.toolingLeadDays	integer or null	If parent supplied
commercial.moldOwnership	string	If parent supplied	Who owns the tool once it is paid for.. One of: customer, factory, unknown
commercial.retoolCost	string or null	If parent supplied
commercial.sampleCost	string or null	If parent supplied
commercial.sampleLeadDays	integer or null	If parent supplied
commercial.productionLeadDays	integer or null	If parent supplied
commercial.leadTimeClockStartsOn	string	If parent supplied	What starts the lead time clock. Two quotes with the same lead days are not comparable when this differs.. One of: po, deposit_cleared, sample_approved, material_arrival, artwork_confirmed, unknown
commercial.paymentTerms	string or null	If parent supplied
commercial.paymentMethod	string	If parent supplied	How payment is made.. One of: tt, lc_at_sight, alibaba_trade_assurance, escrow, other, unknown
commercial.depositPct	string or null	If parent supplied
commercial.balanceTrigger	string	If parent supplied	What releases the balance payment.. One of: before_shipment, against_bl_copy, against_passed_inspection, on_delivery, other, unknown
commercial.fixturesPaidBy	string	If parent supplied	Who pays for test and assembly fixtures.. One of: factory, customer, shared, unknown
commercial.inspectionReportPaidBy	string	If parent supplied	Who pays for the third party inspection report.. One of: factory, customer, shared, unknown
commercial.exclusions	string[]	If parent supplied	What the quoted price excludes. Empty when nothing was listed, which is not the same as nothing being excluded.
commercial.nreLines	object[]	If parent supplied	Non recurring engineering lines as submitted. Empty when none were listed.
commercial.nreLines[].label	string	If parent supplied
commercial.nreLines[].category	string	If parent supplied
commercial.nreLines[].amount	number	If parent supplied
commercial.nreLines[].deliverable	string	No
commercial.revisionClause	string or null	If parent supplied
validity	object	Yes
validity.validUntil	string or null	If parent supplied
validity.state	string	If parent supplied	One of: valid, expired, unknown
maglevFee	string or null	Yes
notes	string or null	Yes
notesTranslated	string or null	Yes
dfmNotes	string or null	Yes
dfmNotesTranslated	string or null	Yes
fileIds	string[]	Yes	Files the supplier attached to this quote version

Full JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "version": {
      "type": "integer",
      "description": "Versions are per invitation. A revision adds a row; it never replaces the earlier one."
    },
    "status": {
      "type": "string",
      "enum": [
        "submitted",
        "revised",
        "accepted",
        "declined"
      ]
    },
    "provenance": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string",
          "const": "supplier_portal_submission"
        },
        "modelExtracted": {
          "type": "boolean",
          "const": false
        },
        "submittedAt": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "submittedByUserId": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid"
            },
            {
              "type": "null"
            }
          ]
        },
        "quoteReference": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "quoteDate": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "source",
        "modelExtracted",
        "submittedAt",
        "submittedByUserId",
        "quoteReference",
        "quoteDate"
      ]
    },
    "answersRevision": {
      "anyOf": [
        {
          "type": "integer",
          "description": "The revision of the request that was in force when the supplier submitted this quote. Null on an RFQ that was never published through the API, and null for a quote that predates every published revision, in which case supersededByRevision names the current one."
        },
        {
          "type": "null"
        }
      ]
    },
    "supersededByRevision": {
      "anyOf": [
        {
          "type": "integer",
          "description": "The current revision when it is later than answersRevision, so this quote was priced against terms that have since been corrected; null when this quote answers the current revision"
        },
        {
          "type": "null"
        }
      ]
    },
    "commercial": {
      "type": "object",
      "properties": {
        "currency": {
          "type": "string",
          "description": "Currency of the quoted prices.",
          "enum": [
            "USD",
            "CNY"
          ]
        },
        "currencyAtColumnDefault": {
          "type": "boolean",
          "description": "True when the stored value is still USD, the column default, so it cannot be read as a currency the supplier declared."
        },
        "incoterm": {
          "type": "string",
          "enum": [
            "EXW",
            "FCA",
            "CPT",
            "CIP",
            "DAP",
            "DPU",
            "DDP",
            "FAS",
            "FOB",
            "CFR",
            "CIF"
          ]
        },
        "incotermAtColumnDefault": {
          "type": "boolean",
          "description": "True when the stored value is still EXW, the column default, so it cannot be read as a trade term the supplier declared."
        },
        "namedPlace": {
          "anyOf": [
            {
              "type": "string",
              "description": "The place the Incoterm is quoted to; null when none was recorded"
            },
            {
              "type": "null"
            }
          ]
        },
        "priceBreaks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "quantity": {
                "type": "number"
              },
              "unitPrice": {
                "type": "number"
              }
            },
            "required": [
              "quantity",
              "unitPrice"
            ]
          },
          "description": "Quantity breaks exactly as submitted. Empty when the supplier quoted no unit price."
        },
        "quoteUnit": {
          "type": "string",
          "description": "What one unit of priceBreaks.unitPrice buys.",
          "enum": [
            "piece",
            "set",
            "unknown"
          ]
        },
        "taxIncluded": {
          "type": "string",
          "description": "Whether the quoted price includes tax.",
          "enum": [
            "included",
            "excluded",
            "unknown"
          ]
        },
        "moq": {
          "anyOf": [
            {
              "type": "integer",
              "description": "Minimum order quantity; null when none was stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "moqDriver": {
          "anyOf": [
            {
              "type": "string",
              "description": "Why that minimum applies, in the supplier's words; null when not stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "toolingCost": {
          "anyOf": [
            {
              "type": "string",
              "description": "Decimal string; null when no tooling cost was stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "toolingType": {
          "type": "string",
          "description": "What tooling the price assumes.",
          "enum": [
            "none",
            "rapid_aluminum",
            "steel_bridge",
            "production_steel",
            "other"
          ]
        },
        "toolingShotLife": {
          "anyOf": [
            {
              "type": "integer",
              "description": "Shots the tool is quoted to last; null when not stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "toolingLeadDays": {
          "anyOf": [
            {
              "type": "integer",
              "description": "Calendar days to cut the tool; null when not stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "moldOwnership": {
          "type": "string",
          "description": "Who owns the tool once it is paid for.",
          "enum": [
            "customer",
            "factory",
            "unknown"
          ]
        },
        "retoolCost": {
          "anyOf": [
            {
              "type": "string",
              "description": "Decimal string; null when no retool price was stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "sampleCost": {
          "anyOf": [
            {
              "type": "string",
              "description": "Decimal string; null when no sample price was stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "sampleLeadDays": {
          "anyOf": [
            {
              "type": "integer",
              "description": "Calendar days to a sample; null when not stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "productionLeadDays": {
          "anyOf": [
            {
              "type": "integer",
              "description": "Calendar days for the production run; null when not stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "leadTimeClockStartsOn": {
          "type": "string",
          "description": "What starts the lead time clock. Two quotes with the same lead days are not comparable when this differs.",
          "enum": [
            "po",
            "deposit_cleared",
            "sample_approved",
            "material_arrival",
            "artwork_confirmed",
            "unknown"
          ]
        },
        "paymentTerms": {
          "anyOf": [
            {
              "type": "string",
              "description": "Payment terms in the supplier's own words; null when none were stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "paymentMethod": {
          "type": "string",
          "description": "How payment is made.",
          "enum": [
            "tt",
            "lc_at_sight",
            "alibaba_trade_assurance",
            "escrow",
            "other",
            "unknown"
          ]
        },
        "depositPct": {
          "anyOf": [
            {
              "type": "string",
              "description": "Decimal string, percent of order value; null when no deposit was stated"
            },
            {
              "type": "null"
            }
          ]
        },
        "balanceTrigger": {
          "type": "string",
          "description": "What releases the balance payment.",
          "enum": [
            "before_shipment",
            "against_bl_copy",
            "against_passed_inspection",
            "on_delivery",
            "other",
            "unknown"
          ]
        },
        "fixturesPaidBy": {
          "type": "string",
          "description": "Who pays for test and assembly fixtures.",
          "enum": [
            "factory",
            "customer",
            "shared",
            "unknown"
          ]
        },
        "inspectionReportPaidBy": {
          "type": "string",
          "description": "Who pays for the third party inspection report.",
          "enum": [
            "factory",
            "customer",
            "shared",
            "unknown"
          ]
        },
        "exclusions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "What the quoted price excludes. Empty when nothing was listed, which is not the same as nothing being excluded."
        },
        "nreLines": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "category": {
                "type": "string"
              },
              "amount": {
                "type": "number"
              },
              "deliverable": {
                "type": "string"
              }
            },
            "required": [
              "label",
              "category",
              "amount"
            ]
          },
          "description": "Non recurring engineering lines as submitted. Empty when none were listed."
        },
        "revisionClause": {
          "anyOf": [
            {
              "type": "string",
              "description": "What a later drawing or specification change costs; null when not stated"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "currency",
        "currencyAtColumnDefault",
        "incoterm",
        "incotermAtColumnDefault",
        "namedPlace",
        "priceBreaks",
        "quoteUnit",
        "taxIncluded",
        "moq",
        "moqDriver",
        "toolingCost",
        "toolingType",
        "toolingShotLife",
        "toolingLeadDays",
        "moldOwnership",
        "retoolCost",
        "sampleCost",
        "sampleLeadDays",
        "productionLeadDays",
        "leadTimeClockStartsOn",
        "paymentTerms",
        "paymentMethod",
        "depositPct",
        "balanceTrigger",
        "fixturesPaidBy",
        "inspectionReportPaidBy",
        "exclusions",
        "nreLines",
        "revisionClause"
      ]
    },
    "validity": {
      "type": "object",
      "properties": {
        "validUntil": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "state": {
          "type": "string",
          "enum": [
            "valid",
            "expired",
            "unknown"
          ]
        }
      },
      "required": [
        "validUntil",
        "state"
      ]
    },
    "maglevFee": {
      "anyOf": [
        {
          "type": "string",
          "description": "Maglev's own line, decimal string. Buyer audience only; a supplier organization key is refused before any read."
        },
        {
          "type": "null"
        }
      ]
    },
    "notes": {
      "anyOf": [
        {
          "type": "string",
          "description": "Supplier commercial notes as submitted. Buyer audience only."
        },
        {
          "type": "null"
        }
      ]
    },
    "notesTranslated": {
      "anyOf": [
        {
          "type": "string",
          "description": "Machine translation of notes; null when none was produced. Buyer audience only."
        },
        {
          "type": "null"
        }
      ]
    },
    "dfmNotes": {
      "anyOf": [
        {
          "type": "string",
          "description": "Supplier design-for-manufacture notes as submitted. Buyer audience only."
        },
        {
          "type": "null"
        }
      ]
    },
    "dfmNotesTranslated": {
      "anyOf": [
        {
          "type": "string",
          "description": "Machine translation of dfmNotes; null when none was produced. Buyer audience only."
        },
        {
          "type": "null"
        }
      ]
    },
    "fileIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Files the supplier attached to this quote version"
    }
  },
  "required": [
    "id",
    "version",
    "status",
    "provenance",
    "answersRevision",
    "supersededByRevision",
    "commercial",
    "validity",
    "maglevFee",
    "notes",
    "notesTranslated",
    "dfmNotes",
    "dfmNotesTranslated",
    "fileIds"
  ]
}