Skip to main content

84 posts tagged with "API"

View All Tags

: Staging

: Production

✨ New

Product Management

Default Variant Name

Product name is now returned as the default variant name for variants without attributes.

seller dashboard

Seller Analytics Access

Seller Analytics is now accessible to sellers directly from the dashboard.

🪲 Fixed

dashboard

Error Message now appears when attempting to publish a product without a category assigned.

dashboard

Fixed issue where the Shopify app did not run when the import button was clicked.

dashboard

Sellers without permission to create custom apps will no longer see the unusable menu option.

dashboard

Fixed issue where staff password updates caused an application error.

dashboard

Taxes for items with a mix of fulfilled, unfulfilled, and declined fulfillment statuses now display correctly.

dashboard

Fixed issue where creating variants with stock simultaneously led to an error.

: Staging

: Production

✨ New

authentication

JWT token expiration

  • Default expiration for Storefront and Back-Office JWT Tokens has been updated to 5 minutes.
  • Post-expiration, a refresh token or re-authentication will be required to generate new tokens.

🪲 Fixed

invoice

Discounted totals are now displayed prominently on Invoices and Pro-Forma Invoice

🚫 Deprecated

catalog

Deprecated groupedProducts

Deprecated groupedProducts, including all related queries and mutations, with a removal date of Sep 27, 2024

shop

Deprecated shop

Deprecated shop, including all related queries and mutations, with a removal date of November 28, 2024.

: Staging

: Production

✨ New

seller mgmt

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.
emails

Order line seller added to email payloads

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

webhooks

Order line metadata added to webhook payloads

Added order line metadata and private metadata to webhooks.

🪲 Fixed

emails

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

emails

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

users

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

🚫 Deprecated

catalog

Removed productVariant.ids

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

orders

Deprecated bids and offers

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

: Staging

: Production

✨ New

general

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.
discounts

New fields for collections

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

💎 Changed

apps

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

catalog

Fixed a TypeError error when querying products.

catalog

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

customers

Fixed an issue where CreateCustomerToken errors were not surfacing properly.

invoices

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

general

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

🚫 Deprecated

general
Deprecated periodicTask

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

  • periodicTask query
  • updatePeriodicTaskEnabled mutation
general
Deprecated sslEnabled for domains

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

general

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

: Staging

: Production

🪲 Fixed

payouts

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

🚫 Deprecated

general

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.

: Staging

: Production

💎 Changed

shipping

Shipping zone owner required

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

warehouses

Warehouse owner required

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

warehouses

Public media query

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

seller mgmt

Seller APPLYING status

The SellerStatus enum now supports the APPLYING status.

seller mgmt

Update seller with tax identifier

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

🪲 Fixed

payouts

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

🚫 Deprecated

affiliates

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.

orders

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.

: Staging

: Production

note

These release notes include changes from v1.43 as well.

✨ New

Orders

Updated the NauticalQuoteOrderSendToCustomer mutation to add the ability to send a payment link to the buyer for draft orders, similar to quote orders.

Also added the ability for buyers to run the NauticalDraftOrderComplete mutation to submit payment and finalize their own draft orders.

note

New instances of the reference storefront include this functionality, but existing instances must update their code to take advantage of these changes.

Catalog

Filter products by mpn

Added the mpn field to the ProductFilterInput filter, to support filtering products by MPN.

Seller mgmt

Added the isMarketplaceSeller boolean field to the Seller object, which identifies if a seller corresponds to the marketplace owner.

Custom fields

Query a custom field template

Added the customFieldTemplate query, to retrieve details for a single custom field template.

💎 Changed

Orders

Query draft orders by token

The nauticalOrderByToken query now returns draft orders.

Apps

Upgraded Klaviyo plugin API

Upgraded the Klaviyo integration to use Klaviyo's updated API endpoint.

Apps

Upgraded Stripe plugin API

Updated the Stripe API integration to account for changes to the Stripe Charges API.

Payouts

Updated permission to view seller order payout data

Updated the permissions required to view payout summary information on seller orders. Sellers now only need the manage_orders permission to view this data.

🪲 Fixed

Payments

Fixed an issue with Stripe ACH payments when the "Store customer cards" setting was turned on.

Payouts

Fixed an issue where the vendorPayoutList query returned excluded payouts.

Payouts

Fixed a display issue with the commission column in vendor payouts.

Catalog

Fixed an issue where sellers with permission to manage attributes could edit or delete attributes added by other sellers.

Catalog

Fixed an issue that caused the following error when creating a new product with a date attribute: TypeError in AttributeValue Model: Multiple Values for 'date_time'

🚫 Deprecated

Apps

Removed the following types around Klaviyo plugin sync, which are longer in use:

  • PluginSyncSettings query
  • PluginSyncUpdate mutation
  • SyncConfiguration
  • SyncConfigurationDirection
Orders

Deprecated the Fulfillment.totalLinesPrice field, which is replaced by the Fulfillment.totalLinesMoney field. This field will be removed by October 25, 2024.

Orders

Deprecated the ShippingZone.default field. ShippingZones are not marked as default anymore. This field will be removed by October 17, 2024.

Designer

Deprecated the following types around designer data, which are no longer in use and will be removed by October 25, 2024.

  • DesignerData
  • DesignerDataCreate
  • DesignerDataUpdate
  • BrandingImagesDelete
  • BrandingUpdate
General

Deprecated the following types around core data, which are no longer in use and will be removed by October 25, 2024.

  • CoreData
  • CoreDataCreate
  • CoreDataUpdate

: Staging

: Production

✨ New

Catalog

Added the value input field to AttributeValueInput to support more input type usages, such as the color value for swatch attributes.

Shipping

Added metadata and privateMetadata to the following models:

  • ShippingMethod
  • ShippingZone

Manage metadata with the metadataUpdate and privateMetadataUpdate mutations.

🪲 Fixed

Webhooks

Fixed an issue where the customer_updated webhook was not being triggered by adding a customer address.

🚫 Deprecated

Shipping

Deprecated the isSellerShippingZoneCreationAllowed field on the MarketplaceConfiguration model. This field will now always be overridden as true and wil be removed soon.

: Staging

: Production

✨ New

Seller mgmt

Seller slug field

Added the slug field to the Seller model.

Seller mgmt

PublicSeller model

Added the PublicSeller model, to retrieve public information about sellers. Also added the sellerBySlug query to retrieve a publicSeller by their unique slug.

🪲 Fixed

Fees

Fixed an issue where you could not add order fees to fulfilled orders.

🚫 Deprecated

Dashboard

Deprecated dashboard types

The following types related to the Dashboard have been deprecated:

  • The dashboard query
  • The dashboardConfigurationUpdate mutation

: Staging

: Production

💎 Changed

user mgmt

The staffUserInput type now accepts the userIsActive field, which is a boolean that can be used to filter if a staff member is active or not.

taxes

Improved handling when Avalara doesn't return a response after posting a transaction.

webhooks

The product_updated webhook will now be triggered by changes to product features.

storefront

Added a MarketplaceConfiguration field for defaultCountry, which will be used to set the default country in the reference storefront in a future release.

🪲 Fixed

payouts

Fixed an issue where refunds in an invalid state could connect to payouts.

🚫 Deprecated

Reviews

Product review deprecations

The following types have been marked for deprecation and will be removed on October 1, 2024:

  • The productRatingsAndReviews query
  • The productReviewSubmit mutation
Catalog

Catalog export deprecations

The catalogExport mutation is no longer supported and has been marked for deprecation. This will be removed on October 1, 2024.

catalog

Catalog type removals

The following previously deprecated types related to catalog management have been removed:

Queries
  • barcodeLookup
  • upcItemDb
  • drugLookup
Mutations
  • productVariantReorder
  • variantImageAssign
  • variantImageUnassign
  • importCatalog
  • exportCatalog
  • exportProducts
  • importProducts
  • attributeReorderValues
Fields
  • Category.url
  • Product.url
  • ProductVariant:
    • quantity
    • quantityAllocated
    • stockQuantity
    • isAvailable
    • availableShippingMethods
orders

Order type removals

The following previously deprecated types related to checkout and orders have been removed:

Mutations
  • acceptBid
  • rejectBid
  • submitRatingAndReview
  • paymentRefund
  • orderCapture
  • orderFulfillmentUpdateReturnStatus
  • orderMarkAsPaid
  • orderRefund
  • nauticalOrderRefund
  • orderVoid
  • bulkFulfillmentReturn
  • sendQuoteToCustomer
  • setWishlistAsDefault
Fields
  • Checkout.availableShippingMethods
  • Checkout.localized
warehouse

Warehouse type removals

The following previously deprecated warehouse mutations have been removed:

Mutations
  • createWarehouse
  • updateWarehouse
  • deleteWarehouse
user mgmt

User type removals

The following previously deprecated user management mutations have been removed:

Mutations
  • requestPasswordReset
  • confirmAccount
  • setPassword
  • requestEmailChange
  • confirmEmailChange
  • accountSetDefaultAddress
webhooks

Webhook type removals

The following previously deprecated webhook and service account types have been removed:

Queries
  • webhooks
  • serviceAccounts
  • serviceAccount
Mutations
  • serviceAccountCreate
  • serviceAccountUpdate
  • serviceAccountDelete
  • serviceAccountTokenCreate
  • serviceAccountTokenDelete
Fields
  • Webhook.serviceAccount
seller mgmt

Seller type removals

The following previously deprecated seller-related mutations have been removed:

Mutations
  • getPayoutOnboardingLink
  • acknowledgeSellerAgreement
  • createSellerData
  • createSellerUserMapping
  • updateSellerData
  • sellerAddNote
  • createSellerShell
  • updateSellerSettings
designer

Designer type removals

The following previously deprecated designer-related mutations have been removed:

Mutations
  • createDesignerData
  • updateDesignerData
  • updateBranding
  • deleteBrandingImages
  • createCoreData
  • updateCoreData
metadata

Metadata type removals

The following previously deprecated metadata mutations have been removed:

Mutations
  • deleteMetadata
  • deletePrivateMetadata
  • updateMetadata
  • updatePrivateMetadata
Plugins

YotPo plugin removal

The YotPo plugin has been removed, including removal of the following types:

  • YotpoCustomer
  • UserInput
  • customerLoyaltyAndReferralsDetails
  • loyaltyAndReferralsInfo
  • YotpoCustomer
  • yotpoLoyaltyAndReferralsCreateOrUpdateCustomerRecord
  • yotpoLoyaltyAndReferralsAwardCustomerLoyaltyPoints

Was this page helpful?