B2b Stores Queries

Manage B2B e-commerce storefronts and their configuration.

B2bStore — Returns the current company's B2B store

GraphQL

query GetB2bStore {
  B2bStore {
    id
    active
    label
    url
    location { id label }
    price_level { id label }
    tax_codes { id label }
    logo { id url }
  }
}

Available fields

Field	Type	Description
id	ID	Unique identifier.
company_id	ID	Company ID.
active	Boolean	Whether the store is active.
label	String	Store name.
url	String	Store URL.
location_id	ID	Default location ID.
price_level_id	ID	Price level ID.
recommended_price_level_id	ID	Recommended price level ID.
settings	JSON	Store settings.
location	Location	Default location.
price_level	PriceLevel	Price level.
recommended_price_level	PriceLevel	Recommended price level.
tax_codes	[TaxCode]	Tax codes.
logo	File	Store logo.
banner	File	Store banner.
login_background	File	Login background image.
about_us_files	[File]	About us files.

---

B2bStoreProducts — Returns the products published to the B2B store

Returns the products available in the B2B store (restricted to published products). Requires the products.view permission.

Example Query:

GraphQL

query B2bStoreProducts(
  $where: QueryB2bStoreProductsWhereWhereConditions,
  $search: String,
  $first: Int,
  $page: Int
) {
  B2bStoreProducts(
    where: $where,
    search: $search,
    first: $first,
    page: $page
  ) {
    paginatorInfo { total }
    data {
      id
      label
      active
      first_variant { id label sku }
    }
  }
}

---

B2bStoreOrders — Returns the orders placed through the B2B store

Returns the orders linked to the B2B store (published only). Requires the orders.view permission.

Example Query:

GraphQL

query B2bStoreOrders(
  $where: QueryB2bStoreOrdersWhereWhereConditions,
  $first: Int,
  $page: Int
) {
  B2bStoreOrders(
    where: $where,
    first: $first,
    page: $page
  ) {
    paginatorInfo { total }
    data {
      id
      label
      status
      total
      dated_at
      customer { id label }
    }
  }
}

---

B2bStoreInvoices — Returns the invoices generated for the B2B store

Returns the invoices linked to the B2B store (published only). Requires the invoices.view permission.

Example Query:

GraphQL

query B2bStoreInvoices(
  $where: QueryB2bStoreInvoicesWhereWhereConditions,
  $first: Int,
  $page: Int
) {
  B2bStoreInvoices(
    where: $where,
    first: $first,
    page: $page
  ) {
    paginatorInfo { total }
    data {
      id
      label
      status
      total
      dated_at
      customer { id label }
    }
  }
}