439 posts tagged with "API"

Base amount money field for better accuracy​

Added a baseAmount field to all money-related objects (Money, MoneyRange, TaxedMoney). This field represents the monetary value in the smallest unit of the currency, offering greater accuracy over the existing amount floating point field.

For example, in currencies with two decimal places like USD, $12.45 will be represented as baseAmount=1245.

The amount field is now deprecated and will be removed in 6 months.

Allow buyer to query suborders​

A buyer can now query me.NauticalOrder.subOrders for the seller order information. Payout-related fields on the seller order will not be visible to the buyer.

Seller ID on multi seller shipping method​

Added the sellerId field to the MultiSellerShippingMethodtype.

Improved webhook logging​

Added webhook logging for request time outs and connection errors.

Fixed an issue where duplicate transaction records could be created against the same Stripe payment intent. This did not affect the actual payment captured by Stripe.

Deprecated money fields​

The amount and localized fields on the money type have been deprecated and will be removed after a deprecation period.

Removed dummy_credit_card payment gateway​

Removed the dummy_credit_card payment gateway. All test payments should be done through the dummy gateway going forward.

Removed RazorPay payment gateway​

Removed the RazorPay payment gateway.

Removed gift card model​

Removed the GiftCard model, including all related queries and mutations.

Buyer access to sub-orders​

Buyers can now view sub-orders within their marketplace orders, providing better visibility into how their purchases are fulfilled across multiple sellers.

Order search by product variant SKU​

Added support for searching orders by grouped product variant SKU, making it easier to find orders containing specific product variants.

Seller identification in shipping methods​

The MultiSellerShippingMethod GraphQL type now exposes the seller's GraphQL ID, providing clearer seller attribution for shipping options.

Currency display improvements​

Added base_amount currency values to queries, providing more consistent currency formatting and display across the platform.

Payment gateway updates​

• Renamed the "Dummy Gateway" to "Test Payments" for clarity.
• Removed the legacy dummy_credit_card gateway.
• Removed the non-functional Razorpay gateway integration.

Fixed an issue where shipping voucher discounts were not being applied correctly during checkout.

Separated the NauticalDraftOrderCreate and NauticalOrderUpdate mutations to prevent conflicts and ensure draft orders are created correctly.

Fixed a race condition in Stripe webhook processing by properly locking checkout and nautical order records during payment updates.

Improved transaction handling in checkoutPaymentCreate to ensure payment records are created atomically.

Improved error logging for webhook deliveries, now capturing timeout and connection errors for better debugging.

Fixed an issue where fulfillment webhooks were failing in the Shopify plugin integration.

Added a proper deprecation notice for the Money.amount field to guide developers toward the correct currency handling approach.

Gift card support removed​

Removed gift card functionality from checkouts, orders, and user accounts. This includes:

• Gift card queries and mutations
• Gift card payment methods
• Gift card refund options

Order line item notes​

Added the ability to add a note per order line item. The following mutations have been added to add line-level notes:

• checkoutLineAddNote: Adds a note to a CheckoutLine.
  note

  When the checkout is converted to an order, any CheckoutLines are converted to NauticalOrder and Order lines.

• nauticalOrderLineAddNote: Adds a note to a NauticalOrderLine.
• orderLineAddNote: Adds a note to an OrderLine.

Learn more ->

New locations queries​

Added the locationSearch and locationGeocode queries, to replace the deprecated mutations.

Email payloads with order line item thumbnails​

Added the original.url field to images on order line items for SendGrid email payloads. This new field provides the URL of the unprocessed, original image, facilitating the integration of image thumbnails in dynamic email templates.

This update provides a way around the SendGrid limitation with accessing the sized thumbnail URLs, which were previously available but incompatible with SendGrid handlebars.

Validation error when payment token already used​

Added a validation error for instances where a token has already been used for a payment.

Sort products or variants by brand or manufacturer​

Added the ability to sort products or variants by the brand and manufacturer fields.

Deprecated location mutations​

The locationSearch and locationGeocode mutations have been deprecated. Instead, use the new locations queries.

Deprecated secondary address​

Deprecated the ShippingMethod.requiresSecondaryAddress and secondaryAddress fields, which were non-functional.

Deprecated shipping fields​

The checkout.shippingMethod and nauticalOrder.shippingMethodName fields have been marked deprecated. These fields were not functional as shipping is stored on the seller order (order).

Removed NauticalFulfillment model​

The following models have bee removed, as fulfillments are tracked at the seller order level.

• NauticalFulfillment
• NauticalFulfillmentLine

This change has been made backwards-compatible. To keep backwards compatibility for NauticalOrder.fulfillments, the type of that field is changed to Fulfillment but the resolver is changed to an empty list.

Removed connection between seller order and payments​

Removed the connection between seller orders (order) and payment objects. This connection had already logically been empty since the deprecation in version 1.9.

As a result, any existing logic querying orders must not explicitly include payments.

Removed taxRate field from order lines​

The taxRate field has been removed from the NauticalOrderLine and OrderLine objects.

Removed nauticalSuborders query​

The nauticalSuborders query has been removed.

Notes on order lines​

Added the ability to include custom notes on individual order lines, providing more flexibility for capturing line-level details and instructions.

Original image URLs in email payloads​

Email notifications now include the original image URLs for products, making it easier to display high-quality product images in custom email templates.

Sort products by brand and manufacturer​

Added support for sorting products and variants by brand and manufacturer, making it easier to organize and browse large product catalogs.

Improved shipping method handling​

Simplified how shipping methods are managed for marketplace orders, improving reliability and making it easier to update shipping information after an order is placed.

Internal data structure improvements​

Updated several internal data structures to improve consistency and maintainability across the platform. These changes are transparent to API consumers.

Fixed an issue where payment webhook race conditions could cause inconsistent order states when multiple payment events occurred simultaneously.

Improved error messages when attempting to create duplicate authentication tokens, making it clearer what action needs to be taken.

Fixed an issue where the seller order status could be incorrect when checking if a seller is the only seller on a marketplace order.

Fixed an issue where webhook payloads could serialize date fields incorrectly, ensuring consistent date formatting across all webhook events.

Enhanced Stripe integration with webhook listeners​

Added webhook listeners for Stripe integrations, ensuring automatic updates to order payment statuses in Nautical. This is particularly useful for Stripe transactions where payment completion is delayed, like ACH payments.

Nautical will now reflect the following Stripe events:

• payment_intent.amount_capturable_updated
• payment_intent.canceled
• payment_intent.payment_failed
• payment_intent.processing
• payment_intent.succeeded

Decline all order lines​

You can now decline all order lines in a seller order. If all lines are cancelled, the seller order status updates to Cancelled. Additionally, the shipping cost for that order resets to $0, and its total cost is deducted from the marketplace order total.

Filter orders by invoice number​

Added the ability to use the search filter to find orders and nauticalOrders by invoice number.

Invoice refresh mutation​

Added the invoiceRefresh mutation, which regenerates an order document using the same invoice number as originally generated.

Learn more ->

Removed items section on invoices​

Invoice documents for orders with declined fulfillments now include a "Removed Items" section, listing each line item that was removed from the order.

Payment token validation​

Updated the checkoutPaymentCreate and nauticalOrderPaymentCreate mutations to include validation of the supplied token. The validation checks ensure:

• The token has not been previously used, preventing duplicate tokens.
• The token is valid according to the gateway, and the amount provided to the API is appropriate for the token.

For Stripe in particular, we now perform the following validation:

• The payment intent specified by the token exists
• The payment amount specified matches the payment intent amount in Stripe
• The payment intent status is either processing, requires_capture, or succeeded

Transaction error enum replaced​

The Transaction.error field is now a string type instead of an enum.

Breaking change for webhooks​

Implemented strictly typed data classes for more robust and structured webhooks. This approach negates the need for custom webhook fields, as we can now generate model-like payloads with more complex nested data structures.

The structure and contents of the following webhook payloads have been changed:

• Product webhooks: product_created, product_updated, product_deleted
• Variant webhooks: variant_created, variant_updated, variant_deleted
• Warehouse webhooks: warehouse_created, warehouse_updated, warehouse_deleted
• Stock webhooks: stock_created, stock_updated, stock_deleted
• Stock allocation webhooks: stock_allocated, stock_deallocated
• Agreement webhooks: agreement_created, agreement_updated, agreement_deleted
• Microsite webhooks: microsite_created, microsite_updated
• Collection webhooks: collection_created, collection_updated, collection_deleted

As a result of these changes, existing logic that utilizes the above webhooks should be updated to align with this new, more structured webhook format. Follow the learn more link below to view the new webhooks.

Learn more ->

Plugin allow sellers field​

The plugin model now has the allowSellers boolean field, which indicates whether sellers can configure the plugin.

Fixed an issue where the option to fulfill items remained available from the marketplace order even after a seller order was cancelled.

Fixed an issue where stock allocated to draft orders wasn't being deallocated upon bulk deletion of those orders.

Fixed an issue that could prevent order emails from being sent with the type error Object of type X is not JSON serializable.

Fixed an issue that prevented the activation of the HERE plugin.

Decline all order lines in a seller order​

Added the ability to decline all order lines within a seller order at once, streamlining order management workflows.

Update PO numbers on finalized orders​

You can now update purchase order (PO) numbers on marketplace orders even after they've been finalized, providing more flexibility in order tracking.

Invoice number filtering​

Added the ability to filter orders and marketplace orders by invoice number, making it easier to locate specific orders.

Invoice refresh mutation​

Introduced a new mutation to refresh invoices, allowing you to regenerate invoice documents when needed.

Stripe payment metadata​

Payment intents created through Stripe now include custom metadata, enabling better tracking and integration with external systems.

Stripe webhook integration​

The Stripe payment plugin now listens to webhooks for real-time payment status updates, including successful payments, cancellations, pending states, failures, capture events, and refunds.

Gateway token validation​

Payment gateway tokens are now validated when creating payments, improving security and reducing payment errors.

Seller configuration limits​

Marketplace operators can now limit which plugins and configurations are available to individual sellers, providing more granular control over seller capabilities.

Refined plugin categories​

Plugin categories have been reorganized to improve discoverability and organization of integrations.

Removed items on documents​

Invoices, packing slips, and purchase orders now include a dedicated section for removed items when applicable.

Fulfillment for cancelled orders​

Orders that have been cancelled can still be fulfilled if needed, providing more flexibility in handling edge cases.

Fixed an issue where stock wasn't properly deallocated when bulk deleting draft orders.

Fixed an issue where dates and decimal values weren't consistently returned as strings in API responses.

Fixed an issue where transaction error messages could be incorrectly formatted.

Fixed an issue with the HERE Maps plugin authentication check URL.

This release contains internal improvements and maintenance updates.

Purchase order numbers on invoices​

Purchase order (PO) numbers added to orders are now automatically included on generated invoices, making it easier to track and reconcile orders.

Filter and sort orders by PO number​

Added the ability to filter and sort marketplace orders by purchase order number, improving order search and management capabilities.

Fixed an issue where declining a fulfillment could result in incorrect tax calculations when using Avalara integration.

Fixed an issue where warehouse information could fail to serialize correctly when the associated address was deleted.

Fixed an issue where top-performing product reports could incorrectly include deleted product variants.

Fixed an issue where refund webhook events were not being logged correctly.

Fixed an issue where newly added price sync options were not displayed for existing Shopify seller configurations.

Fixed an issue with inventory deallocation for draft orders that could cause incorrect stock levels.

This release contains internal improvements and maintenance updates.

Backorders API​

Added the ability to enable backorders with customizable settings, allowing you to set backorder thresholds and selectively activate this feature for specific product variants.

To activate the backorders feature, a new marketplace configuration enableBackorders field has been introduced. Once enabled, you can control which items are eligible for backordering through the allowBackorders boolean field on each product variant. By default, both fields are set to false (off) to maintain your current settings.

When adding or adjusting stock, StockInput now accepts the outOfStockThreshold field, which defaults to 0. This field allows you to set a negative value for how far stock levels can go below zero. When backorders and thresholds are set up, the quantityAvailable field can take on a negative value, but it cannot go past the limits defined by the outOfStockThreshold.

Learn more ->

Webhook queue manager plugins​

Refactored webhooks to enhance security and functionality in conjunction with queue manager plugins. If any of the following plugins are enabled, webhooks will now be directed to their respective queues:

• Amazon Simple Queue Service
• Google Cloud Pub/Sub
• Microsoft Azure Service Bus

Store PO number on Checkout and NauticalOrder​

Added the capability to store Purchase Order (PO) numbers in both the Checkout and NauticalOrder models. This includes the ability to search for purchase order numbers using the search filter.

During the checkout process, you can use the checkoutAddPoNumbers mutation to input one or more PO numbers, allowing buyers to easily reference these during transactions. You can also use the checkoutRemovePoNumber mutation to remove a PO number.

Once the checkout is completed, these PO numbers are saved to the resulting NauticalOrder. This ensures that each marketplace order can have one or more associated PO numbers for record-keeping and future reference. After checkout, you can manage PO numbers by updating the NauticalOrder directly.

Fixed an issue where bulk creation of variants resulted in a GraphQL error ID cannot represent value: None.

Fixed an issue that prevented searching for seller orders by the customer's company name. The search filter now includes the customer's company name if the token running the GraphQL query has the manage_users permission.

Fixed an issue where the orderCancel or orderBulkCancel mutations were not triggering stock deallocated webhooks upon cancelling orders.

Fixed an issue where changing the customer in a draft marketplace order did not update the customer address. Now, when you select a different customer, the address fields will automatically update to reflect the new customer's information.

API v1.12.1​

Surface PO number on invoice​

Invoices now display PO numbers if they are available on the corresponding marketplace order (NauticalOrder). Invoices must be regenerated for this change to take effect.

Fixed an issue where declining the full quantity of an order line from a marketplace order did not update the nauticalOrder.total.tax.amount value to reflect the adjusted tax amount. This inconsistency also affected invoice information, making invoices different from what was displayed on the Order Details page in the dashboard.

Fixed an issue related to the caching of invoice shipping prices and order line tax amounts.

Fixed an issue where the query for top-performing products incorrectly included deleted variants.

API v1.12.2​

Sort orders by PO number​

Added the ability to sort marketplace orders (nauticalOrder) by PO numbers.

Fixed an issue where, when enableStockAllocationForDrafts=true, stock was not being deallocated after deleting draft orders.

Fixed an issue where the Shopify price sync toggle was not appearing for sellers with existing integrations.

API v1.12.3​

Fixed an issue that prevented the order_creation email to send in certain circumstances with an TypeError: Object of type X is not JSON serializable error.