Documentation
Feedback
Guides
VTEX IO Apps

VTEX IO Apps
B2B SuiteB2B Quotes & Carts
B2B Quotes GraphQL API
vtex.b2b-quotes-graphql
Version: 3.0.0
Latest version: 3.0.0

This article provides a reference guide to the B2B Quotes GraphQL API, with details about the available queries and mutations for the B2B Quotes app. The API supports quote management and related configurations in a B2B environment, enabling users to retrieve, create, and update quotes, as well as manage application settings and permissions.

Schema overview

Query

classDiagram
  direction LR
  class AdminSetup {
    cartLifeSpan Int
    quotesManagedBy QuotesManagedBy!
  }

  class AppSettings {
    adminSetup AdminSetup
  }

  class QuoteUpdate {
    email String
    role String
    date String
    status String
    note String
  }

  class QuoteItem {
    name String
    skuName String
    refId String
    id String
    productId String
    imageUrl String
    listPrice Float
    price Float
    quantity Int
    sellingPrice Float
    seller String
  }

  class Quote {
    id String
    referenceName String
    creatorEmail String
    creatorRole String
    creationDate String
    expirationDate String
    lastUpdate String
    updateHistory [QuoteUpdate]
    items [QuoteItem]
    subtotal Float
    status String
    organization String
    organizationName String
    costCenter String
    costCenterName String
    viewedBySales Boolean
    viewedByCustomer Boolean
    salesChannel String
    seller String
    parentQuote String
    hasChildren Boolean
  }

  class Pagination {
    page Int
    pageSize Int
    total Int
  }

  class Quotes {
    data [Quote]
    pagination Pagination
  }

  class Query {
    getAppSettings AppSettings
    getQuoteEnabledForUser(email String!) Boolean
    getQuote(id String) Quote
    getQuotes(organization [String], costCenter [String], status [String], search String, page Int, pageSize Int, sortOrder String, sortedBy String) Quotes
    getChildrenQuotes(id String, page Int, pageSize Int, sortOrder String, sortedBy String) Quotes
  }

  AppSettings --> AdminSetup : adminSetup
  Query --> AppSettings : getAppSettings
  Quote --> QuoteUpdate : updateHistory
  Quote --> QuoteItem : items
  Query --> Quote : getQuote
  Quotes --> Quote : data
  Quotes --> Pagination : pagination
  Query --> Quotes : getQuotes
  Query --> Quotes : getChildrenQuotes

  click Query href "#query"
  click AppSettings href "#appsettings"
  click AdminSetup href "#adminsetup"
  click Quote href "#quote"
  click QuoteUpdate href "#quoteupdate"
  click QuoteItem href "#quoteitem"
  click Quotes href "#quotes"
  click Pagination href "#pagination"

Mutation

classDiagram
  direction LR
  class AdminSetup {
    cartLifeSpan Int
    quotesManagedBy QuotesManagedBy!
  }

  class AppSettings {
    adminSetup AdminSetup
  }

  class Mutation {
    createQuote(input QuoteInput!) String
    updateQuote(input QuoteUpdateInput!) String
    useQuote(id String, orderFormId String) String
    clearCart(orderFormId String) String
    saveAppSettings(input AppSettingsInput!) AppSettings
  }

  AppSettings --> AdminSetup : adminSetup
  Mutation --> AppSettings : saveAppSettings

  click Mutation href "#mutation"
  click AppSettings href "#appsettings"
  click AdminSetup href "#adminsetup"

Schema description

Arguments must be provided by the user. Required fields are marked with an exclamation mark (!).

AppSettings

AppSettingsInput

AdminSetup

Quotes

Quote

QuoteInput

QuoteUpdate

QuoteItem

QuoteUpdateInput

QuoteItemInput

Pagination

Enums

QuotesManagedBy

See also
Vtex.b2b Quotes Graphql
VTEX IO Apps
VTEX App Store
VTEX IO Apps