@nautical-commerce/graphql-schema 2.21.0 → 2.23.0

package/nautical/schema.graphql

@@ -1700,6 +1700,34 @@ type Query {
     contexts: [AppDashboardIntegrationContextEnum!]
   ): [AppDashboardIntegration!]!
 
+  """
+  Get order metrics including time series data for bar charts and status breakdown for pie charts. Automatically filtered by seller for seller staff users.
+  """
+  orderMetrics(
+    """Date range for the metrics query"""
+    dateRange: AnalyticsDateRangeInput!
+
+    """How to group the time series data"""
+    groupBy: DateGroupingEnum!
+
+    """Optional seller ID to filter by (MPO only)"""
+    sellerId: ID
+  ): OrderMetrics
+
+  """
+  Get sales metrics including time series data for bar charts and breakdown by seller (MPO only) and category. Automatically filtered by seller for seller staff users.
+  """
+  salesMetrics(
+    """Date range for the metrics query"""
+    dateRange: AnalyticsDateRangeInput!
+
+    """How to group the time series data"""
+    groupBy: DateGroupingEnum!
+
+    """Optional seller ID to filter by (MPO only)"""
+    sellerId: ID
+  ): SalesMetrics
+
   """Look up a marketplace agreement by ID or slug."""
   agreement(
     """ID of the marketplace agreement."""
@@ -12243,6 +12271,81 @@ enum AppSortField {
   CREATION_DATE
 }
 
+"""Order metrics including time series and status breakdown"""
+type OrderMetrics {
+  """Order counts over time, grouped by the specified granularity"""
+  timeSeries: [TimeSeriesDataPoint!]!
+
+  """Total number of orders in the date range"""
+  total: Int!
+
+  """Orders broken down by status for pie chart"""
+  statusBreakdown: [PieChartSegment!]!
+}
+
+"""Represents a single point in time-series data for charts"""
+type TimeSeriesDataPoint {
+  """The date/time for this data point"""
+  date: DateTime!
+
+  """The numeric value (count or sum)"""
+  value: Decimal!
+
+  """Human-readable label for this period (e.g., 'Jan 2025')"""
+  label: String
+}
+
+"""Represents a segment in pie chart data"""
+type PieChartSegment {
+  """Label for this segment"""
+  label: String!
+
+  """Numeric value for this segment"""
+  value: Decimal!
+
+  """Percentage of total (0-100)"""
+  percentage: Decimal!
+
+  """Optional color code for rendering"""
+  color: String
+}
+
+"""Input type for specifying date range in analytics queries."""
+input AnalyticsDateRangeInput {
+  """Start of date range (inclusive)"""
+  start: DateTime!
+
+  """End of date range (inclusive)"""
+  end: DateTime!
+}
+
+"""Enum for date grouping granularity in time-series charts."""
+enum DateGroupingEnum {
+  DAILY
+  WEEKLY
+  MONTHLY
+  QUARTERLY
+  YEARLY
+}
+
+"""Sales metrics including time series and category breakdown"""
+type SalesMetrics {
+  """Net sales over time, grouped by the specified granularity"""
+  timeSeries: [TimeSeriesDataPoint!]!
+
+  """Total net sales amount in the date range"""
+  total: Decimal!
+
+  """Currency code for the sales figures"""
+  currency: String!
+
+  """Sales broken down by seller (MPO only)"""
+  bySeller: [PieChartSegment!]
+
+  """Sales broken down by product category"""
+  byCategory: [PieChartSegment!]!
+}
+
 type AgreementCountableConnection {
   """Pagination data for this connection."""
   pageInfo: PageInfo!
@@ -12528,7 +12631,7 @@ type Mutation {
     description: String
 
     """
-    Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: image/x-bmp, application/x-pdf, drawing/x-dwg, image/heic, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/msword, text/rtf, text/plain, application/x-dwg, image/x-tif, image/svg+xml, application/vnd.ms-word, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/x-zip-compressed, application/svg+xml, image/png, image/svg, application/acad, application/x-csv, application/pdf, text/x-pdf, application/vnd.ms-powerpoint, application/gzip-compressed, application/gzipped, image/gif, application/x-eps, application/x-rar, application/x-gzip, image/jpg, application/tiff, application/gzip, image/x-tiff, text/svg, application/dxf, drawing/dwg, image/x-dwg, application/x-autocad, text/x-comma-separated-values, application/eps, image/heic-sequence, image/heif-sequence, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.presentationml.slideshow, image/tif, application/x-dxf, application/dwg, application/postscript, application/csv, application/x-rtf, image/jpeg, text/pdf, image/tiff, application/vnd.oasis.opendocument.presentation, image/vnd.dwg, application/x-acad, application/vnd.pdf, application/acrobat, application/vnd.ms-excel, application/x-tiff, image/x-eps, image/webp, text/csv, image/x-ms-bmp, text/comma-separated-values, application/rtf, drawing/x-dwf, image/heif, image/eps, image/bmp, text/x-csv, application/x-tar, application/zip, application/x-rar-compressed, application/excel, application/tif, pplication/vnd.rar, application/x-jpg, text/svg-xml, image/x-dxf, image/dxf, application/vnd.oasis.opendocument.text, application/x-tif, application/vnd.oasis.opendocument.spreadsheet, application/jpg.
+    Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: application/pdf, application/tiff, application/eps, application/x-gzip, image/vnd.dwg, application/x-acad, image/x-tif, application/x-eps, image/tif, application/gzip, image/x-ms-bmp, application/x-pdf, application/tif, text/svg-xml, image/jpg, application/x-tif, image/x-dxf, pplication/vnd.rar, text/comma-separated-values, application/acad, text/x-comma-separated-values, text/rtf, image/tiff, image/heic, image/dxf, drawing/x-dwg, application/x-autocad, image/svg+xml, application/x-dxf, text/pdf, application/vnd.ms-powerpoint, image/gif, text/svg, image/x-dwg, application/msword, application/vnd.ms-word, text/x-csv, image/bmp, application/dwg, image/png, drawing/x-dwf, image/x-tiff, application/x-rtf, image/eps, application/vnd.ms-excel, image/x-bmp, application/vnd.oasis.opendocument.spreadsheet, application/x-rar, text/plain, application/csv, application/x-tiff, image/svg, application/x-csv, application/x-jpg, image/webp, application/postscript, application/excel, application/vnd.oasis.opendocument.presentation, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.pdf, image/heif, application/gzip-compressed, application/x-tar, application/jpg, image/heic-sequence, application/x-zip-compressed, application/zip, application/gzipped, application/svg+xml, drawing/dwg, application/acrobat, application/vnd.openxmlformats-officedocument.presentationml.presentation, image/jpeg, application/vnd.openxmlformats-officedocument.presentationml.slideshow, text/csv, application/x-dwg, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/rtf, image/x-eps, application/dxf, text/x-pdf, image/heif-sequence, application/x-rar-compressed.
     """
     file: Upload!
 
@@ -12617,7 +12720,9 @@ type Mutation {
     id: ID!
   ): PayoutDelete
 
-  """Modifies the status of a payout"""
+  """
+  Modifies the status of a payout. Valid transitions: DRAFT→LOCKED, LOCKED→DRAFT, LOCKED→PAID, PAID→ARCHIVED, ERROR→DRAFT. Use ERROR→DRAFT to recover payouts that failed during processing.
+  """
   payoutStatusUpdate(
     """Fields required to update a payout status."""
     id: ID!
@@ -12653,13 +12758,17 @@ type Mutation {
     input: VendorPayoutStatusInput!
   ): VendorPayoutStatusUpdate
 
-  """Include vendor payouts."""
+  """
+  Include vendor payouts. Only operates on vendor payouts where the parent payout is in DRAFT or ERROR state.
+  """
   vendorPayoutsBulkInclude(
     """List of vendor payout IDs to include."""
     ids: [ID!]!
   ): VendorPayoutsBulkInclude
 
-  """Exclude vendor payouts."""
+  """
+  Exclude vendor payouts. Only operates on vendor payouts where the parent payout is in DRAFT or ERROR state.
+  """
   vendorPayoutsBulkExclude(
     """List of vendor payout IDs to exclude."""
     ids: [ID!]!
@@ -15954,7 +16063,9 @@ type PayoutDelete {
   payout: Payout
 }
 
-"""Modifies the status of a payout"""
+"""
+Modifies the status of a payout. Valid transitions: DRAFT→LOCKED, LOCKED→DRAFT, LOCKED→PAID, PAID→ARCHIVED, ERROR→DRAFT. Use ERROR→DRAFT to recover payouts that failed during processing.
+"""
 type PayoutStatusUpdate {
   """Payout that was updated."""
   payout: Payout
@@ -16015,14 +16126,18 @@ input VendorPayoutStatusInput {
   payoutAmount: String!
 }
 
-"""Include vendor payouts."""
+"""
+Include vendor payouts. Only operates on vendor payouts where the parent payout is in DRAFT or ERROR state.
+"""
 type VendorPayoutsBulkInclude {
   """Returns how many objects were affected."""
   count: Int!
   payoutErrors: [PayoutError!]!
 }
 
-"""Exclude vendor payouts."""
+"""
+Exclude vendor payouts. Only operates on vendor payouts where the parent payout is in DRAFT or ERROR state.
+"""
 type VendorPayoutsBulkExclude {
   """Returns how many objects were affected."""
   count: Int!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nautical-commerce/graphql-schema",
-  "version": "v2.21.0",
+  "version": "v2.23.0",
   "description": "Traide API GraphQL Schema",
   "main": "./nautical/schema.graphql",
   "scripts": {