: Staging
As Nautical continues to evolve, APIs undergo periodic reorganization and improvement. Over time, certain APIs that have been deprecated are removed.
We want to make sure you have advanced notice that we are removing a number of deprecated APIs in January 2024. You will need to update any code using the types, inputs, queries, and mutations outlined below.
Many of the API entities being removed have already been replaced with new entities. To ensure your code remains up to date with the latest API, we have provided guidance below on how to update your code accordingly.
These changes will start rolling out on January 19, 2024.
Queries being removed
Query | Upgrade guidance |
---|---|
barcodeLookup | N/A |
draftOrders.created | Use the filter field instead. |
drugLookup | N/A |
NauticalDraftOrders.created | Use the filter field instead. |
NauticalOrders.created | Use the filter field instead. |
NauticalOrders.status | Use the filter field instead. |
Orders.created | Use the filter field instead. |
Orders.status | Use the filter field instead. |
serviceAccount | Use the app query instead. |
serviceAccounts | Use the apps query instead. |
upcItemDb | N/A |
webhooks | Use the webhooks field on the app or apps query instead. |
Mutations being removed
Mutation | Upgrade guidance |
---|---|
acceptBid | Use the bidAccept mutation instead. |
accountSetDefaultAddress | Use the accountAddressSetDefault mutation instead. |
acknowledgeSellerAgreement | Use the sellerAgreementAcknowledge mutation instead. |
attributeReorderValues | Use the attributeValuesReorder mutation instead. |
bulkFulfillmentReturn | Use the fulfillmentBulkReturn mutation instead. |
checkoutShippingMethodUpdate | Use the CheckoutSellerShippingMethodsUpdate mutation. |
confirmAccount | Use the accountConfirm mutation. |
confirmEmailChange | Use the emailChangeConfirm mutation. |
createCoreData | Use the coreDataCreate mutation. |
createDesignerData | Use the designerDataCreate mutation. |
createHashtag | Use the hashtagCreate mutation. |
createMention | Use the mentionCreate mutation. |
createSellerData | Use the sellerDataCreate mutation. |
createSellerShell | Use the sellerShellCreate mutation. |
createSellerUserMapping | Use the sellerUserMappingCreate mutation. |
createWarehouse | Use the warehouseCreate mutation. |
deleteBrandingImages | Use the brandingImagesDelete mutation. |
deleteMetadata | Use the metadataDelete mutation. |
deletePrivateMetadata | Use the privateMetadataDelete mutation. |
deleteWarehouse | Use the warehouseDelete mutation. |
exportCatalog | Use the catalogExport mutation. |
exportProducts | Use the productsExport mutation. |
getPayoutOnboardingLink | Use the vendorPayoutOnboardingLinkRequest mutation. |
importCatalog | Use the catalogImport mutation. |
importProducts | Use the productsImport mutation. |
NauticalOrderRefund | Use the refundCreate mutation instead and then add the Nautical order using the refundLinesAdd mutation. |
orderCapture | Direct capture against seller orders is unsupported as Payments are only attached to the NauticalOrder. Use NauticalOrderCapture instead. |
orderFulfillmentUpdateReturnStatus | Use the fulfillmentBulkReturn mutation instead. |
orderMarkAsPaid | Direct update of seller orders to paid is unsupported as Payments are only attached to the NauticalOrder. Use NauticalOrderMarkAsPaid instead. |
orderRefund | Use the refundCreate mutation instead and then add the order using the refundLinesAdd mutation. |
orderVoid | Direct void against seller orders is unsupported as Payments are only attached to the NauticalOrder. Use NauticalOrderVoid instead. |
paymentRefund | Use the refundCreate mutation instead and then utilize the refundPaymentsAdd mutation. |
productVariantReorder | Use the productReorderVariants mutation. |
rejectBid | Use the bidReject mutation. |
requestEmailChange | Use the emailChangeRequest mutation. |
requestPasswordReset | Use the passwordRequestReset field. |
sellerAddNote | Use the sellerNoteCreate mutation. |
sendQuoteToCustomer | Use the NauticalQuoteOrderSendToCustomer mutation. |
serviceAccountCreate | Use the appCreate mutation instead. |
serviceAccountDelete | Use the appDelete mutation instead. |
serviceAccountTokenCreate | Use the appTokenCreate mutation instead. |
serviceAccountTokenDelete | Use the appTokenDelete mutation instead. |
serviceAccountUpdate | Use the appUpdate mutation instead. |
setPassword | Use the passwordSet mutation. |
setWishlistAsDefault | Use the wishlistSetDefault mutation. |
submitRatingAndReview | Use the productReviewSubmit mutation instead. |
updateBranding | Use the brandingUpdate mutation |
updateCoreData | Use the coreDataUpdate mutation. |
updateDesignerData | Use the designerDataUpdate mutation. |
updateMetadata | Use the metadataUpdate mutation. |
updatePrivateMetadata | Use the privateMetadataUpdate mutation. |
updateSellerData | Use the sellerDataUpdate mutation. |
updateSellerSettings | Use the sellerSettingsUpdate mutation. |
updateWarehouse | Use the warehouseUpdate mutation. |
variantImageAssign | Use the productVariantImageAssign mutation instead. |
variantImageUnassign | Use the productVariantImageUnassign mutation instead. |
Inputs being removed
Input | Upgrade guidance |
---|---|
AppInput.isActive | Use the appActivate and appDeactivate mutations instead. |
AttributeInput.value | Use values instead. |
CheckoutCustomerAttach.customer_id | The ID of the customer. To identify a customer you should authenticate with JWT. |
DetailedSellerInput.status | This field will be ignored in the mutation and a seller will be created in pending status |
DocumentAdd.documentId | To attach a document to related instances, use documentAttach mutation instead. |
DocumentAdd.ids | To attach a document to related instances, use documentAttach mutation instead. |
DraftOrderInput.discount | Use NauticalOrderUpdateApplyVoucherCode mutation instead. |
DraftOrderInput.shippingMethod | Unsupported field. Use orderUpdateShipping mutation instead. |
DraftOrderInput.voucher | Use NauticalOrderUpdateApplyVoucherCode mutation instead. |
NauticalHistoricalOrderInput.shippingMethod | Use NauticalOrderUpdateShipping mutation instead. |
WebhookCreateInput.serviceAccount | Use the app field instead. |
WebhookUpdateInput.serviceAccount | Use the app field instead. |
Types being removed
Type | Upgrade guidance |
---|---|
*.*.errors | Removal impacts all mutations that have the errors field. Use typed errors with error codes, for example checkoutErrors . |
Category.url | N/A |
Checkout.availableShippingMethods | Use the availableShippingMethodsBySeller field instead. |
Money.localized | Price formatting according to the current locale should be handled by the frontend client. |
NauticalOrder.availableShippingMethods | Use the availableShippingMethodsBySeller field instead. |
NauticalOrderLine.quantity | Use the more explicit quantityOrdered instead. |
NauticalOrderLine.quantityFulfilled | Marketplace Orders are not fulfilled. Use quantityFulfilled on the seller OrderLine instead. |
NauticalSecondaryOrderLine.quantity | Use the more explicit quantityOrdered instead. |
OrderLine.quantity | Use the more explicit quantityOrdered instead. |
Product.url | N/A |
ProductVariant.isAvailable | Use the stocks field instead. |
ProductVariant.quantity | Use the stocks field instead. |
ProductVariant.quantityAllocated | Use the stocks field instead. |
ProductVariant.stockQuantity | Use the quantityAvailable field instead. |
SecondaryOrderLine.quantity | Use the more explicit quantityOrdered instead. |
Webhook.serviceAccount | Use the app field instead. |