Summary
ShopifySharp v6.18.0 is now available on Nuget! This release updates our target Shopify API version to 2024-07. You can upgrade ShopifySharp using the dotnet CLI – dotnet add package shopifysharp --version 6.18.0
– or with your IDE's package manager UI. Once you upgrade ShopifySharp, don't forget to upgrade your Shopify webhook API version in the Partner dashboard to match.
What's changed
- All service classes now use API version 2024-07, as noted above.
- All GraphQL entities in the
ShopifySharp.GraphQL
namespace have been regenerated based on Shopify's 2024-07 GraphQL schema. - Added a new
Transaction.AdjustmentReason
property. - Added new
DeliveryMethod.ServiceCode
,DeliveryMethod.SourceReference
,DeliveryMethod.BrandedPromise
andDeliveryMethod.AdditionalInformation
properties. - Deprecated the
CountryService
,CountryServiceFactory
and related interfaces. Shopify has deprecated the REST API's Country endpoint, and they recommend developers migrate to the Storefront GraphQL API as an alternative. - Removed deprecated
Order.ProcessingMethod
property. - Removed deprecated
FulfillmentServiceEntity.FulfillmentOrdersOptIn
property. Fulfillment Orders are now the only processing method for fulfillment services and fulfilling orders in general, so there is no more concept of "opting in" to fulfillment orders. - Removed deprecated
ShopifyException
http properties. If you used. these properties, you should be able to switch all of yourcatch (ShopifyException ex) where (ex.StatusCode)
to(ShopifyHttpException ex) where (ex.StatusCode)
. - Moved
ShopifyHttpException
into theShopifySharp
namespace for consistency. - Added a default exception message for
ShopifyExponentialRetryCanceledException
.
These changes should only affect you if you've created your own class that extends one of ShopifySharp's services, or if you've created a custom IRequestExecutionPolicy
:
- Removed deprecated
RequestResult.Response
property. If you need access to the response status code, you should be able to useRequestResult.StatusCode
instead. - Removed deprecated
ShopifyService.PrepareRequest
method. This was replaced withShopifyService.BuildRequestUri
. - Removed deprecated
ShopifyService.BuildShopUri
method. This was replaced withIShopifyDomainUtility.BuildShopDomainUri
. - Removed deprecated
CloneableRequestMessage.Clone
method. This was replaced withCloneableRequestMessage.CloneAsync
.
Full Changelog: ShopifySharp/6.17.0...ShopifySharp/6.18.0
How to support ShopifySharp
If you find ShopifySharp useful, please consider contributing to the project! If you'd rather contribute financially, you can do so by sponsoring the author here on Github, or by purchasing a copy of The Shopify Development Handbook on Gumroad.