Menu

API reference · Schema

StorefrontPreviewResponse

StorefrontPreviewResponsecontract storefront.preview.response
  • labelconst "preview"required
  • priced_atIsoDatetimerequired
  • currencystringrequired
    pattern ^[A-Z]{3}$
  • tax_ruleobjectrequired
    • pack_codestringrequired
      pattern ^[A-Z]{2}$
    • pack_versionintegerrequired
      ≥ 1≤ 9007199254740991
  • linesarray of objectrequired
    • line_nointegerrequired
      ≥ 1≤ 9007199254740991
    • item_idUuid7required
    • variant_idUuid7 | nullrequired
    • qty_milliintegerrequired
      > 0≤ 9007199254740991
    • unit_price_minorintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
    • options_minorintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
    • line_discount_minorintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
    • tax_classstringrequired
      pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
    • tax_minorintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
    • line_total_minorintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
    • price_refstringrequired
      pattern ^⟨cite:(?:row:[a-z_][a-z0-9_]*\.[a-z_][a-z0-9_]*:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|(?:doc|msg|claim|snapshot):[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})(?:·(?:0|[1-9][0-9]*)-(?:0|[1-9][0-9]*))?⟩$
    • option_refsarray of stringrequired
    • deal_refsarray of stringrequired
    • coupon_refsarray of stringrequired
    • tax_rate_bpintegerrequired
      ≥ 0≤ 10000
    • tax_componentsarray of objectrequired
      • codestringrequired
      • rate_bpintegerrequired
        ≥ 0≤ 10000
      • amount_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
  • subtotal_minorintegerrequired
    ≥ -9007199254740991≤ 9007199254740991
  • discount_minorintegerrequired
    ≥ -9007199254740991≤ 9007199254740991
  • tax_minorintegerrequired
    ≥ -9007199254740991≤ 9007199254740991
  • total_minorintegerrequired
    ≥ -9007199254740991≤ 9007199254740991
  • refusalsarray of objectrequired
    • line_nointeger | nullrequired
      ≥ 1≤ 9007199254740991
    • reason_codeReasonCoderequired
    • paramsobjectoptional
      • line_nointegeroptional
        ≥ 1≤ 9007199254740991
      • item_idUuid7optional
      • variant_idUuid7 | nulloptional
      • deal_idUuid7optional
      • codestringoptional
        pattern ^[A-Z0-9][A-Z0-9-]{2,31}$
      • min_spend_minorintegeroptional
        ≥ -9007199254740991≤ 9007199254740991
      • shortfall_minorintegeroptional
        ≥ -9007199254740991≤ 9007199254740991
      • old_total_minorintegeroptional
        ≥ -9007199254740991≤ 9007199254740991
      • new_total_minorintegeroptional
        ≥ -9007199254740991≤ 9007199254740991
      • currencystringoptional
        pattern ^[A-Z]{3}$
  • tax_componentsarray of objectrequired
    • codestringrequired
    • rate_bpintegerrequired
      ≥ 0≤ 10000
    • amount_minorintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
  • prices_include_taxbooleanrequired

Used by