@nautical-commerce/graphql-schema 1.67.1 → 1.68.0-10-gff9b7f576

package/nautical/schema.graphql

@@ -458,19 +458,19 @@ type Query {
     """Return the last n elements from the list."""
     last: Int
   ): AgreementCountableConnection
-  sellerListCards(period: ReportingPeriod!, identifier: ID): SellerCards
-  sellerDetailCards(period: ReportingPeriod!, identifier: ID!): SellerDetailCards
+  sellerListCards(period: ReportingPeriod!, identifier: ID): SellerCards @deprecated(reason: "This will be removed on April 16, 2025")
+  sellerDetailCards(period: ReportingPeriod!, identifier: ID!): SellerDetailCards @deprecated(reason: "This will be removed on April 16, 2025")
 
   """Number of new sellers created in given period."""
-  newSellers(period: ReportingPeriod!): Int
+  newSellers(period: ReportingPeriod!): Int @deprecated(reason: "This will be removed on April 16, 2025")
 
   """Number of orders placed by sellers in given period."""
-  sellerOrders(period: ReportingPeriod!, identifier: ID): Int
+  sellerOrders(period: ReportingPeriod!, identifier: ID): Int @deprecated(reason: "This will be removed on April 16, 2025")
 
   """
   Return the total commissions earned across all sellers for the given period.
   """
-  sellerCommissions(period: ReportingPeriod!, identifier: ID): Money
+  sellerCommissions(period: ReportingPeriod!, identifier: ID): Money @deprecated(reason: "This will be removed on April 16, 2025")
 
   """Look up an refund by ID."""
   refund(
@@ -1038,13 +1038,13 @@ type Query {
 
     """Search term to use when retrieving typeform forms"""
     search: String
-  ): TypeformForms
+  ): TypeformForms @deprecated(reason: "Typeform support will be removed on April 17, 2025")
 
   """Form details for specified form_id"""
   typeformForm(
     """ID of the form to get details for."""
     id: ID
-  ): TypeformForm
+  ): TypeformForm @deprecated(reason: "Typeform support will be removed on April 17, 2025")
 
   """Get the flows associated with a particular plugin and seller"""
   pluginFlows(
@@ -1053,7 +1053,7 @@ type Query {
 
     """ID of the seller."""
     seller: ID
-  ): [Flow!]
+  ): [Flow!] @deprecated(reason: "Typeform support will be removed on April 17, 2025")
 
   """Get client secret if necessary for frontend configuration."""
   getClientSecret(
@@ -2840,10 +2840,6 @@ type ProductVariant implements Node & ObjectWithMetadata {
   id: ID!
   createdAt: DateTime!
   updatedAt: DateTime!
-
-  """Product model code"""
-  description: String @deprecated(reason: "This will be removed on April 15, 2025.")
-  descriptionHtml: String!
   externalId: String
   externalSource: String
   seoTitle: String
@@ -2866,7 +2862,6 @@ type ProductVariant implements Node & ObjectWithMetadata {
   """Whether the product variant is published."""
   isPublished: Boolean!
   overrideCurrency: Boolean!
-  requiresQuote: Boolean!
   allowBackorders: Boolean
 
   """
@@ -2897,8 +2892,14 @@ type ProductVariant implements Node & ObjectWithMetadata {
   """Whether this variant is visible on the buyer side or not"""
   isVisible: Boolean! @deprecated(reason: "This will be removed on April 15, 2025.")
 
+  """Product description"""
+  description: String @deprecated(reason: "This will be removed on April 15, 2025.")
+
+  """Product description HTML"""
+  descriptionHtml: String @deprecated(reason: "This will be removed on April 15, 2025.")
+
   """Product variant size info."""
-  size: VariantSize
+  size: VariantSize @deprecated(reason: "This will be removed on April 17, 2025.")
 
   """List of attributes assigned to this variant."""
   attributes: [SelectedAttribute!]!
@@ -2961,6 +2962,7 @@ type ProductVariant implements Node & ObjectWithMetadata {
 
   """List of vouchers associated with the product."""
   vouchers: [Voucher!]!
+  requiresQuote: Boolean @deprecated(reason: "This field will be removed on April 25th, 2025.")
 
   """
   The sub status of the product variant. This will be the same as product's sub status.
@@ -3833,9 +3835,6 @@ type Order implements Node & ObjectWithMetadata {
   """Marketplace order that this seller order belongs to."""
   marketplaceOrder: NauticalOrder
 
-  """Latest vendor payout this order is in"""
-  vendorPayout: VendorPayout @deprecated(reason: "This will be removed on January 15, 2025. Use the more accurate vendorPayouts field instead.")
-
   """All vendor payouts that contain this order"""
   vendorPayouts: [VendorPayout!]
 
@@ -4746,7 +4745,7 @@ type Permission {
 enum PermissionEnum {
   MANAGE_USERS
   MANAGE_STAFF
-  MANAGE_PERMISSIONS
+  MANAGE_PERMISSIONS @deprecated(reason: "This will be removed on April 23, 2025.")
   MANAGE_APPS
   MANAGE_DISCOUNTS
   MANAGE_DOCUMENTS
@@ -7081,18 +7080,7 @@ type Agreement implements Node {
   seoDescription: String
   slug: String!
   title: String!
-
-  """Commission type"""
-  commissionType: CommissionTypeEnum! @deprecated(reason: "Markup commissions will be removed on January 23, 2025.")
   defaultCommission: Decimal!
-
-  """Markup commission type"""
-  markupCommissionType: MarkupCommissionTypeEnum! @deprecated(reason: "Markup commissions will be removed on January 23, 2025.")
-
-  """
-  If a markup commission is selected, this is the amount of the commission.
-  """
-  markupCommissionValue: Decimal @deprecated(reason: "Markup commissions will be removed on January 23, 2025.")
   isActive: Boolean
 
   """List of granular commissions associated with the agreement."""
@@ -7103,22 +7091,6 @@ type Agreement implements Node {
   fees: [AgreementFees!]!
 }
 
-enum CommissionTypeEnum {
-  """Gross Price Commission"""
-  MARKETPLACE
-
-  """Markup Commission"""
-  WHOLESALE
-
-  """Absolute Price Commission"""
-  DROPSHIPPING
-}
-
-enum MarkupCommissionTypeEnum {
-  """Percentage"""
-  PERCENTAGE
-}
-
 """An agreement commission"""
 type AgreementCommission implements Node {
   """The ID of the object"""
@@ -9115,6 +9087,7 @@ type Policy implements Node & ObjectWithMetadata {
   """The ID of the object"""
   id: ID!
   publicationDate: Date
+  isPublished: Boolean!
   createdAt: DateTime!
   updatedAt: DateTime!
   content: String!
@@ -9132,9 +9105,6 @@ type Policy implements Node & ObjectWithMetadata {
 
   """List of public metadata items. Can be accessed without permissions."""
   metadata: [MetadataItem!]!
-
-  """Whether the policy is published."""
-  isPublished: Boolean!
 }
 
 """An enumeration."""
@@ -9225,6 +9195,7 @@ input CategoryFilterInput {
   customFields: [AttributeInput!]
   metadata: MetadataFilterInput
   privateMetadata: MetadataFilterInput
+  allowProductAssignment: Boolean
 }
 
 input CategorySortingInput {
@@ -10564,6 +10535,7 @@ type Page implements Node & ObjectWithMetadata {
   """The ID of the object"""
   id: ID!
   publicationDate: Date
+  isPublished: Boolean!
   createdAt: DateTime!
   updatedAt: DateTime!
   content: String!
@@ -10580,9 +10552,6 @@ type Page implements Node & ObjectWithMetadata {
 
   """List of public metadata items. Can be accessed without permissions."""
   metadata: [MetadataItem!]!
-
-  """Whether the page is published."""
-  isPublished: Boolean!
   image(
     """Featured image for the page."""
     size: Int
@@ -10860,7 +10829,7 @@ type Menu implements Node {
 }
 
 """
-Represents a single item of the related menu. Can store categories, collection or pages.
+Represents a single item of the related menu. Can store categories, collection, pages, sellers, products, content or policy pages.
 """
 type MenuItem implements Node {
   """The ID of the object"""
@@ -10871,6 +10840,10 @@ type MenuItem implements Node {
   category: Category
   collection: Collection
   page: Page
+  seller: Seller
+  product: Product
+  content: Content
+  policy: Policy
   level: Int!
   children: [MenuItem!]!
 
@@ -10956,7 +10929,9 @@ type MarketplaceConfiguration {
   id: UUID!
   marketplaceName: String!
   requireProductApproval: Boolean!
-  requireProductTypes: Boolean!
+
+  """True if products require product types to be created"""
+  requireProductTypes: Boolean @deprecated(reason: "This will be removed on April 15, 2025.")
 
   """Determines payout status transformation strategy"""
   payoutAutomationStrategy: MarketplaceConfigurationPayoutAutomationStrategyEnum
@@ -11002,6 +10977,9 @@ type MarketplaceConfiguration {
 
   """Default weight unit."""
   defaultWeightUnit: WeightUnitsEnum
+
+  """Default length unit."""
+  defaultLengthUnit: LengthUnitsStrEnum
   automaticFulfillmentDigitalProducts: Boolean!
   defaultDigitalMaxDownloads: Int
   defaultDigitalUrlValidDays: Int
@@ -11631,6 +11609,16 @@ enum FulfillmentModelEnum {
   HYBRID
 }
 
+"\n    String enum counterpart of the LengthUnits.\n    "
+enum LengthUnitsStrEnum {
+  IN
+  FT
+  YD
+  MM
+  CM
+  M
+}
+
 type EmailEventCountableConnection {
   """Pagination data for this connection."""
   pageInfo: PageInfo!
@@ -13203,7 +13191,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/svg, image/x-tiff, text/x-csv, image/gif, application/x-gzip, image/svg+xml, drawing/x-dwg, text/x-pdf, text/plain, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/jpg, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/x-tif, image/bmp, application/svg+xml, application/dxf, image/heif-sequence, text/comma-separated-values, application/gzipped, application/gzip, application/gzip-compressed, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/eps, text/svg-xml, application/zip, application/x-rar, application/vnd.pdf, application/acad, image/heic, drawing/x-dwf, pplication/vnd.rar, application/x-zip-compressed, image/heic-sequence, image/tif, text/rtf, application/vnd.oasis.opendocument.presentation, application/x-tiff, application/vnd.oasis.opendocument.spreadsheet, image/heif, image/dxf, application/vnd.ms-word, application/x-jpg, text/svg, application/csv, application/excel, application/acrobat, application/jpg, application/rtf, application/x-rtf, text/csv, application/postscript, application/vnd.ms-powerpoint, application/vnd.ms-excel, application/x-dwg, application/dwg, text/pdf, image/eps, application/x-pdf, application/x-csv, application/tiff, application/vnd.oasis.opendocument.text, application/tif, application/x-dxf, image/x-dxf, image/x-dwg, image/webp, image/x-bmp, image/x-ms-bmp, image/tiff, text/x-comma-separated-values, application/x-autocad, image/x-eps, application/x-eps, image/x-tif, drawing/dwg, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/x-tar, application/pdf, image/png, image/vnd.dwg, application/x-acad, image/jpeg, application/x-rar-compressed.
+    Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: image/heif, application/vnd.oasis.opendocument.text, application/x-jpg, application/x-dwg, application/rtf, application/vnd.openxmlformats-officedocument.presentationml.presentation, image/x-tiff, application/eps, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.pdf, image/eps, image/svg, text/pdf, text/svg, image/x-ms-bmp, application/x-dxf, application/jpg, application/vnd.ms-word, application/x-tiff, text/x-csv, application/gzip, application/excel, application/gzipped, text/svg-xml, text/x-comma-separated-values, application/vnd.ms-powerpoint, image/jpg, application/acrobat, text/x-pdf, application/dxf, image/bmp, application/x-rar, application/csv, application/msword, application/x-autocad, image/webp, image/heic-sequence, application/postscript, drawing/x-dwf, drawing/x-dwg, application/pdf, application/x-pdf, image/jpeg, application/zip, image/vnd.dwg, pplication/vnd.rar, application/acad, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/x-tif, application/x-csv, image/png, application/x-zip-compressed, application/vnd.oasis.opendocument.presentation, text/plain, application/x-rtf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/svg+xml, application/gzip-compressed, application/tif, application/tiff, drawing/dwg, application/vnd.ms-excel, image/tiff, application/vnd.oasis.opendocument.spreadsheet, image/svg+xml, application/dwg, application/x-eps, text/rtf, application/x-gzip, application/x-acad, image/tif, image/x-dwg, text/comma-separated-values, image/gif, image/dxf, text/csv, image/heif-sequence, image/x-eps, image/heic, image/x-bmp, application/x-tar, image/x-dxf, image/x-tif, application/x-rar-compressed.
     """
     file: Upload!
 
@@ -15280,7 +15268,7 @@ type Mutation {
   """Creates a new menu item."""
   menuItemCreate(
     """
-    Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item.
+    Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection`, `seller`, `product`, `content`, 'policy` is allowed per item.
     """
     input: MenuItemCreateInput!
   ): MenuItemCreate
@@ -15303,7 +15291,7 @@ type Mutation {
     id: ID!
 
     """
-    Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item.
+    Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection`, `seller`, `product`, `content`, `policy` is allowed per item.
     """
     input: MenuItemInput!
   ): MenuItemUpdate
@@ -15440,13 +15428,13 @@ type Mutation {
 
     """Fields required to update a plugins sync settings."""
     input: PluginFlowInput
-  ): PluginFlowUpdate
+  ): PluginFlowUpdate @deprecated(reason: "Typeform support will be removed on April 17, 2025")
 
   """Delete plugin flow."""
   pluginFlowDelete(
     """ID of flow to delete."""
     id: ID!
-  ): PluginFlowDelete
+  ): PluginFlowDelete @deprecated(reason: "Typeform support will be removed on April 17, 2025")
 
   """
   Retrieves an onboarding link for the given vendor from the given gateway if available.
@@ -15467,11 +15455,6 @@ type Mutation {
 
     """ID of the vendor to retrieve an onboarding link for"""
     vendorId: ID!
-
-    """
-    Whether the vendor to retrieve an onboarding link for is a SELLER or an AFFILIATE
-    """
-    vendorType: String @deprecated(reason: "This will be removed on January 24, 2025.")
   ): VendorPayoutOnboardingLinkRequest
 
   """
@@ -15627,9 +15610,6 @@ type Mutation {
     """Checkout ID."""
     checkoutId: ID!
 
-    """ID of microsite that checkout was completed from"""
-    microsite: ID @deprecated(reason: "This will be removed on January 24, 2025.")
-
     """Client-side generated data required to finalize the payment."""
     paymentData: JSONString
 
@@ -16605,7 +16585,7 @@ input MarketplaceConfigurationInput {
   requireProductApproval: Boolean
 
   """True if products require product types to be created"""
-  requireProductTypes: Boolean
+  requireProductTypes: Boolean @deprecated(reason: "This will be removed on April 15, 2025.")
 
   """Updates status transformation strategy for payout."""
   payoutAutomationStrategy: MarketplaceConfigurationPayoutAutomationStrategyEnum = null
@@ -16666,6 +16646,9 @@ input MarketplaceConfigurationInput {
   """Default weight unit."""
   defaultWeightUnit: WeightUnitsEnum = null
 
+  """Default length unit."""
+  defaultLengthUnit: LengthUnitsStrEnum = null
+
   """Enable automatic fulfillment for all digital products."""
   automaticFulfillmentDigitalProducts: Boolean
 
@@ -16753,9 +16736,6 @@ enum PayoutErrorCode {
 }
 
 input PayoutCreateInput {
-  """Vendor type for the payout"""
-  vendorType: String @deprecated(reason: "This will be removed on January 24, 2025")
-
   """
   Payout end date. ISO 8601 standard. Can not be greater than current date.
   """
@@ -17080,13 +17060,13 @@ input AgreementInput {
   updatedAt: String
 
   """Gross Price, Markup, Absolute etc"""
-  commissionType: CommissionTypeEnum
+  commissionType: CommissionTypeEnum @deprecated(reason: "This will be removed on April 23, 2025.")
 
   """Percentage by default"""
-  markupCommissionType: MarkupCommissionTypeEnum
+  markupCommissionType: MarkupCommissionTypeEnum @deprecated(reason: "This will be removed on April 23, 2025.")
 
   """Markup commission percentage for all items"""
-  markupCommissionValue: Decimal
+  markupCommissionValue: Decimal @deprecated(reason: "This will be removed on April 23, 2025.")
 }
 
 input SeoInput {
@@ -17097,6 +17077,22 @@ input SeoInput {
   description: String
 }
 
+enum CommissionTypeEnum {
+  """Gross Price Commission"""
+  MARKETPLACE
+
+  """Markup Commission"""
+  WHOLESALE
+
+  """Absolute Price Commission"""
+  DROPSHIPPING
+}
+
+enum MarkupCommissionTypeEnum {
+  """Percentage"""
+  PERCENTAGE
+}
+
 """Deletes a agreement."""
 type AgreementDelete {
   agreementErrors: [AgreementError!]!
@@ -17611,12 +17607,12 @@ input WebhookCreateInput {
   """The url to receive the payload."""
   targetUrl: String
 
-  """
-  The events that webhook wants to subscribe. The CHECKOUT_QUANTITY_CHANGED is depreacted. It will be removed in Nautical 3.0
-  """
+  """The events that webhook wants to subscribe."""
   events: [WebhookEventTypeEnum!]
 
-  """ID of the app to which webhook belongs."""
+  """
+  ID of the app to which webhook belongs. If not specified, a bearer token must be used and the webhook will be attached to the app the bearer token belongs to.
+  """
   app: ID
 
   """Determine if webhook will be set active or not."""
@@ -17653,12 +17649,12 @@ input WebhookUpdateInput {
   """The url to receive the payload."""
   targetUrl: String
 
-  """
-  The events that webhook wants to subscribe. The CHECKOUT_QUANTITY_CHANGED is depreacted. It will be removed in Nautical 3.0
-  """
+  """The events that webhook wants to subscribe."""
   events: [WebhookEventTypeEnum!]
 
-  """ID of the app to which webhook belongs."""
+  """
+  ID of the app to which webhook belongs. If not specified, a bearer token must be used and the webhook will be attached to the app the bearer token belongs to.
+  """
   app: ID
 
   """Determine if webhook will be set active or not."""
@@ -19764,7 +19760,7 @@ input ProductVariantCreateInput {
   description: String @deprecated(reason: "This will be removed on April 15, 2025.")
 
   """Product variant description (HTML)."""
-  descriptionHtml: String
+  descriptionHtml: String @deprecated(reason: "This will be removed on April 15, 2025.")
 
   """Price of the particular variant."""
   price: PositiveDecimal
@@ -19795,13 +19791,13 @@ input ProductVariantCreateInput {
   weight: WeightScalar
 
   """Size of the Product Variant."""
-  size: VariantSizeInput
+  size: VariantSizeInput @deprecated(reason: "This field will be removed on April 17th, 2025.")
 
   """Name for the variant."""
   name: String
 
   """True if variant requires quote pricing."""
-  requiresQuote: Boolean
+  requiresQuote: Boolean @deprecated(reason: "This field will be removed on April 25th, 2025.")
 
   """Substatus the variant is to be changed to."""
   subStatus: ProductVariantSubStatusEnum @deprecated(reason: "This field will be removed on April 15th, 2025. ProductVariant substatus will be the same as product substatus")
@@ -19905,7 +19901,7 @@ input ProductVariantBulkCreateInput {
   description: String @deprecated(reason: "This will be removed on April 15, 2025.")
 
   """Product variant description (HTML)."""
-  descriptionHtml: String
+  descriptionHtml: String @deprecated(reason: "This will be removed on April 15, 2025.")
 
   """Price of the particular variant."""
   price: PositiveDecimal
@@ -19936,13 +19932,13 @@ input ProductVariantBulkCreateInput {
   weight: WeightScalar
 
   """Size of the Product Variant."""
-  size: VariantSizeInput
+  size: VariantSizeInput @deprecated(reason: "This field will be removed on April 17th, 2025.")
 
   """Name for the variant."""
   name: String
 
   """True if variant requires quote pricing."""
-  requiresQuote: Boolean
+  requiresQuote: Boolean @deprecated(reason: "This field will be removed on April 25th, 2025.")
 
   """Substatus the variant is to be changed to."""
   subStatus: ProductVariantSubStatusEnum @deprecated(reason: "This field will be removed on April 15th, 2025. ProductVariant substatus will be the same as product substatus")
@@ -20084,7 +20080,7 @@ input ProductVariantInput {
   description: String @deprecated(reason: "This will be removed on April 15, 2025.")
 
   """Product variant description (HTML)."""
-  descriptionHtml: String
+  descriptionHtml: String @deprecated(reason: "This will be removed on April 15, 2025.")
 
   """Price of the particular variant."""
   price: PositiveDecimal
@@ -20115,13 +20111,13 @@ input ProductVariantInput {
   weight: WeightScalar
 
   """Size of the Product Variant."""
-  size: VariantSizeInput
+  size: VariantSizeInput @deprecated(reason: "This field will be removed on April 17th, 2025.")
 
   """Name for the variant."""
   name: String
 
   """True if variant requires quote pricing."""
-  requiresQuote: Boolean
+  requiresQuote: Boolean @deprecated(reason: "This field will be removed on April 25th, 2025.")
 
   """Substatus the variant is to be changed to."""
   subStatus: ProductVariantSubStatusEnum @deprecated(reason: "This field will be removed on April 15th, 2025. ProductVariant substatus will be the same as product substatus")
@@ -21674,6 +21670,18 @@ input MenuItemInput {
 
   """Page to which item points."""
   page: ID
+
+  """Seller to which item points."""
+  seller: ID
+
+  """Product to which item points."""
+  product: ID
+
+  """Storefront contenet page to which item points."""
+  content: ID
+
+  """Policy page to which item points."""
+  policy: ID
 }
 
 """Deletes a menu."""
@@ -21725,6 +21733,18 @@ input MenuItemCreateInput {
   """Page to which item points."""
   page: ID
 
+  """Seller to which item points."""
+  seller: ID
+
+  """Product to which item points."""
+  product: ID
+
+  """Storefront contenet page to which item points."""
+  content: ID
+
+  """Policy page to which item points."""
+  policy: ID
+
   """Menu to which item belongs."""
   menu: ID!
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nautical-commerce/graphql-schema",
-  "version": "v1.67.1",
+  "version": "v1.68.0-10-gff9b7f576",
   "description": "## Getting Started",
   "main": "./nautical/schema.graphql",
   "scripts": {