463 posts tagged with "API"

Enhanced seller agreement management​

• When a seller's agreement is changed with sellerDataUpdate, the agreement history will now be saved.
• Added the sellerAgreements query to retrieve the agreement history for a seller.
• Added the AgreementSellers.effectiveAt datetime field, that records when an agreement went into effect.
• Ledger calculations will now use the agreement effectiveAt field when calculating commissions, rather than the date the agreement was acknowledged.
• Added new mutations, sellerAgreementAssign and sellerAgreementDelete to have better control over managing seller agreements.
• Buyers will no longer be able to check out with items sold by a seller who has not signed their marketplace agreement.

Order line seller added to email payloads​

Adding the seller for each order line in the order confirmation email payloads.

Order line metadata added to webhook payloads​

Added order line metadata and private metadata to webhooks.

Fixed an issue that caused order fulfillment email to not be sent.

Fixed an issue where the order partially cancelled email was not sent.

Fixed an issue with URL validation for creating staff members and updating staff email or password.

Removed productVariant.ids​

Removed the deprecated ids argument for the productVariant query, which has passed its deprecation period.

Deprecated bids and offers​

Deprecated bids and offers, including all related queries and mutations, with a removal date of November 21, 2024.

Seller agreement management​

Added comprehensive support for managing seller agreements with effective dates:

• New queries to retrieve seller agreements and their effective dates
• Ability to create and delete seller agreements
• Automatic tracking of all seller plan updates
• Agreement effective dates now properly considered when calculating prices and ledger entries

Seller information in order confirmations​

Order confirmation emails and webhooks now include detailed seller information for each order line, making it easier to identify which seller fulfilled each item.

Agreement-based product visibility​

Products and variants from sellers without signed agreements are now automatically filtered from search results and checkout, ensuring customers only see items from authorized sellers.

Fixed an issue where declining the full quantity of an order line could result in incorrect ledger amounts.

Fixed an issue where the original product price was not being used correctly in certain order calculations.

Prevented the ability to fulfill refunded order lines without properly updating the declined quantity field.

Fixed URL validation issues when creating staff accounts, changing passwords, and updating email addresses from the dashboard.

Marketplace shipping methods​

Added support for marketplace-level shipping methods on checkouts, allowing operators to configure shipping options that apply across all sellers.

Enhanced order and checkout data​

Added marketplace shipping details and related fields to NauticalOrder and Checkout objects, providing more flexibility in managing marketplace-wide shipping configurations.

Collection-level discount fields​

Added discount-related fields to the Collection type, making it easier to display and manage promotional pricing at the collection level.

GraphiQL playground​

Added an interactive GraphiQL playground for easier API exploration and testing during development.

Page duplication in editor​

Added the ability to duplicate pages in the content editor, streamlining content management workflows.

External ID and source tracking​

Added externalId and externalSource fields to multiple object types (products, variants, users, orders, categories, product types, attributes, and warehouses), enabling better integration with third-party systems and allowing sorting by these fields.

Simplified webhook transaction handling​

Streamlined the handling of pending webhook transactions, improving reliability and reducing complexity in webhook processing.

Fixed an issue where the available_currencies field could cause resolution errors in certain queries.

Added missing seller_errors field to several mutations, ensuring consistent error reporting across seller-related operations.

Fixed an issue where nauticalDraftOrderComplete could fail to properly lock orders during completion, potentially causing race conditions.

Added missing error classes for agreement-related mutations, improving error handling and consistency.

Fixed an issue that could prevent updating checkout values back to their previous state in certain scenarios.

Fixed invoices to correctly display discounted totals when the discounts feature is enabled, ensuring accurate pricing information.

Fixed proforma invoices to correctly show discount information alongside regular invoices.

Fixed invoices to display correct tax and total amounts based on the discount feature flag status.

Fixed email notifications to be sent to all marketplace operator users instead of just a subset.

Improved query performance by removing unnecessary database refreshes that were causing additional queries.

Fixed order confirmation emails to display discounted amounts when the discounts feature is enabled.

Fixed an issue where attribute assignments could fail to order correctly when certain values were present.

Fixed unreliable behavior in custom field operations, improving consistency and stability.

Fixed incorrect exception handling in the createCustomerToken mutation.

Fixed externalSource resolvers to return correct values across all object types.

Removed several deprecated input fields and type definitions as part of ongoing API cleanup efforts.

Deprecated unused VIN_DECODE_* webhook event enums, which will be removed in a future release.

GraphiQL playground​

We've upgraded our GraphQL API playground to GraphiQL, the industry-standard graphical interactive in-browser GraphQL IDE. This upgrade brings several enhancements:

• A more reliable and up-to-date development environment.
• Easily construct queries by simply clicking on items in our schema, for more intuitive and efficient API interactions.

New fields for collections​

Added the onSale boolean field, sales list, and vouchers list fields to the Collection model.

Sellers no longer need to enable webhook schedules as an additional step after connecting a plugin. Webhooks will be processed automatically for new plugins.

Fixed a TypeError error when querying products.

Fixed an issue where the externalSource field could resolve to the plugin name instead of the plugin ID for imported attributes and product templates.

Fixed an issue where CreateCustomerToken errors were not surfacing properly.

Fixed an issue where the proforma invoice totals section didn't match the same layout as other invoices.

Fixed an issue where certain mutations were missing error classes, including seller, agreement, branding, and designer mutations.

Deprecated periodicTask​

The following API items have been deprecated, with a removal date of November 9, 2024:

• periodicTask query
• updatePeriodicTaskEnabled mutation

Deprecated sslEnabled for domains​

The Domains.sslEnabled field has been marked for deprecation, with a removal date of November 14, 2024.

Removed previously deprecated fields​

Removed the following previously deprecated fields:

• checkoutComplete.volumeDiscountsBySeller
• MarketplaceConfiguration.availableCurrencies
• AppInput.isActive
• CheckoutCustomerAttach.customerId
• DocumentAdd.ids
• DocumentAdd.documentId
• DetailedSellerInput.status
• DraftOrderInput.discount
• DraftOrderInput.shippingMethod
• DraftOrderInput.voucher
• NauticalHistoricalOrderInput.shippingMethod
• AttributeInput.value
• WebhookCreateInput.serviceAccount
• WebhookUpdateInput.serviceAccount

Simplified webhook transaction handling​

Improved the handling of pending webhook transactions, making webhook processing more reliable and easier to manage.

Marketplace shipping methods​

Added support for marketplace-level shipping methods in checkout, allowing operators to configure shipping options that apply across all sellers.

GraphiQL playground​

Added an interactive GraphiQL playground for easier API exploration and testing.

Discount fields on collections​

Added discount-related fields to the Collection type, making it easier to display promotion information on collection pages.

Enhanced marketplace order fields​

Added new fields to NauticalOrder and Checkout objects to support more detailed order management and tracking.

Fixed an issue where the available_currencies field could cause resolution errors in certain queries.

Fixed an issue where filtering orders by APPLYING status could return incorrect results.

Added missing seller_errors fields to several mutations for more consistent error handling.

Fixed a race condition in nauticalDraftOrderComplete by ensuring the order is properly locked during completion.

Added missing error classes for agreement-related mutations to improve error reporting.

Fixed an issue where updating order checkpoints to previous values was incorrectly blocked.

Fixed invoice line items to correctly display discounted totals instead of undiscounted amounts.

Dashboard URL configuration​

Added the ability to configure a custom dashboard URL for each marketplace, providing more flexibility in directing sellers and administrators to their management interfaces.

Seller application checkpoints​

Introduced new status enums for tracking seller application progress, making it easier to manage and monitor the onboarding process.

Country-based shipping method filtering​

Shipping methods can now be filtered by country and area, allowing for more precise control over which shipping options are available to customers based on their location.

Default marketplace content​

New marketplace installations now automatically include default content and configuration data, streamlining the initial setup process.

Automatic fulfillment model updates​

When a product's fulfillment model changes, the sellerFulfilledByMarketplace flag now updates automatically to maintain consistency across the platform.

Fixed an issue where buyer ledgers were not being created correctly for local buyer accounts.

Fixed ledger balancing issues that could occur when partially declining a fulfillment, ensuring accurate financial tracking.

Fixed calculation errors when processing declined fulfillments, ensuring discounted totals are properly accounted for in refund amounts.

Fixed tax calculation discrepancies when declining fulfillments, ensuring accurate tax adjustments based on discounted totals.

Fixed an issue where deleting a payout could fail if its associated event log had already been removed.

Fixed incorrect money type handling in ledger-related API responses, ensuring consistent data formatting.

Removed deprecated API fields and mutations​

Removed several previously deprecated API fields and mutations that have reached their end-of-life dates:

• Money.amount field
• Mutation.errors field
• AttributeInput.value field
• Various deprecated payout-related fields and mutations

If you're still using any of these deprecated features, please update your integration to use the current alternatives.

Fixed an issue where a foreign key error could occur during payout deletion.

Removed deprecated items​

The following API entities have passed their deprecation window and have been removed:

Fields:

• *.*.errors
• Checkout.sellerShippingMethods
• Checkout.shippingMethod
• Money.amount
• NauticalOrder.fulfillments
• NauticalOrder.sellerShippingMethods
• NauticalOrder.shippingMethod
• Order.payments
• Order.totalAuthorized
• Order.totalBalance
• Order.totalCaptured
• Payment.order
• ProductType.taxRate
• Payout.penalties
• Shop.homepageCollection
• VendorPayout.average
• VendorPayout.gross
• VendorPayout.penalty
• VendorPayout.taxes
• VendorPayout.volumeDiscounts

Mutations:

• HomepageCollectionUpdate
• LocationGeocode
• LocationSearch

Types:

• LocationGeocode
• LocationSearch

Update your storefront to ensure you are not calling any of the above fields. For the full list of deprecations and suggested replacements, see GraphQL API Deprecations and Removals.

Seller application management​

Added a complete seller application workflow, allowing prospective sellers to submit applications and marketplace operators to review and approve them. The seller status now includes an "APPLYING" state to track applications in progress.

Shipping discount visibility​

Shipping discounts are now visible directly on the checkout, making it easier to see how vouchers and sales affect shipping costs.

Seller-specific shipping zones and warehouses​

Shipping zones and warehouses now belong to specific sellers, providing better organization and control for multi-vendor marketplaces.

Fulfillment model configuration​

Added the ability to configure fulfillment models at the marketplace level, giving operators more control over how orders are processed and fulfilled.

Seller data management improvements​

Seller owners can now update their own seller data and manage seller identifiers, streamlining the seller onboarding and management process.

Custom field template improvements​

Custom field templates can now be resolved by enum, and custom attributes handling has been aligned with product and variant attributes for consistency.

Fixed an issue where the manual payment gateway wasn't properly stored during the payout process.

Fixed a bug where shipping voucher discounts weren't being calculated correctly in certain scenarios.

Fixed an issue where media queries required authentication when they should have been publicly accessible.

Fixed an issue where default shipping prices weren't working correctly with the dummy tax plugin.

Enabled atomic mutations to ensure database consistency across all GraphQL operations.

Deprecated features​

The following features have been deprecated and will be removed in a future release:

• Affiliate functionality
• Channel-based operations (replaced with seller-based approaches)
• Several unused fields on the Shop type
• Strict product image handling mode
• Adyen payment gateway (non-functional)

Shipping zone owner required​

The shippingZone.owner field is now required when creating a shipping zone.

Warehouse owner required​

The warehouse.owner field is now required when creating a warehouse.

Public media query​

The media query is now a public query that does not require authentication.

Seller APPLYING status​

The SellerStatus enum now supports the APPLYING status.

Update seller with tax identifier​

The sellerDataUpdate mutation now supports the identifiers input for setting the seller's tax identification number.

Fixed an issue where VendorPayout.gateway returned a blank response when querying a payout using the Manual payout gateway.

Deprecated affiliates​

Deprecated the affiliates model and related fields, which will be removed on October 26, 2024. For the full list of deprecations, see GraphQL API Deprecations and Removals.

Deprecated channels​

Deprecated the channels model and related fields, which will be removed on October 29, 2024. For the full list of deprecations, see GraphQL API Deprecations and Removals.

Marketplace seller identification​

Added the ability to identify marketplace sellers with a dedicated boolean field, making it easier to distinguish between marketplace operators and individual sellers.

Invoice generation for draft orders​

Added support for generating invoices for draft orders, streamlining the order approval and payment collection process.

Google Analytics integration​

Added a new Google Analytics plugin, allowing marketplaces to track customer behavior and conversion data directly from the platform.

Query ledgers and custom field templates​

Added the ability to query accounting ledgers and individual custom field templates, providing more flexibility for reporting and custom data management.

Automatic admin user creation for sellers​

When creating local sellers, the platform now automatically creates corresponding admin users, reducing manual setup steps.

Marketplace fulfillment configuration​

Updated marketplace configuration to support new fulfillment models, allowing operators to control whether sellers are fulfilled by the marketplace or handle their own fulfillment.

Fixed an issue where seller-created product attributes could be unintentionally removed by other sellers on the marketplace.

Fixed an issue where order payout data was accessible to users without the proper ManageOrders permission.

Fixed an issue where certain refunds were incorrectly included in payout calculations, leading to inaccurate seller payouts.

Fixed an issue where tax-related metadata keys were cleared instead of being properly removed, causing inconsistent tax calculations in some cases.

Fixed an issue where product data was not correctly displayed based on draft versus published view.

Fixed an issue preventing buyers from completing draft orders in certain scenarios.

Fixed an issue with Stripe ACH payments when using stored customer payment methods.

Updated Stripe integration to support newer API versions with changes to charge handling.

Deprecated fields​

The following fields and models are now deprecated and will be removed in a future release:

• Branding and designer data fields
• CoreData model
• Fulfillment.totalLinesPrice (replaced by totalLinesMoney)