Struct ShopifyClient 

pub struct ShopifyClient { /* private fields */ }

An Admin GraphQL client for one shop and one token.

A clone is cheap. Debug redacts the token.

Implementations

impl ShopifyClient

pub fn new( shop: ShopDomain, api_version: ApiVersion, access_token: impl Into<String>, ) -> Result<Self>

Make a client for shop with a new HTTP connection pool.

Errors

Returns Error::Config when the token is blank, or Error::Http when the HTTP client does not build.

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Send requests to base_url instead of https://{shop}. Use it for a local stub in tests. The requests carry the access token, so use only a host you trust.

pub const fn with_retry(self, retry: RetryPolicy) -> Self

Set the retry policy.

pub const fn shop(&self) -> &ShopDomain

The shop this client calls.

pub const fn api_version(&self) -> &ApiVersion

The API version this client uses.

pub fn endpoint(&self) -> String

The GraphQL endpoint URL.

pub async fn graphql(&self, query: &str, variables: Value) -> Result<Value>

Run a GraphQL document and return its data.

Errors

Returns Error::Http on a transport failure, Error::ShopifyApi on a non-success status, Error::GraphQl when the response has errors, Error::UnexpectedResponse when the body has no data, and Error::Throttled when the retries run out.

pub async fn query<T: DeserializeOwned>( &self, query: &str, variables: Value, ) -> Result<T>

Run a GraphQL document and deserialize its data into T.

Errors

See graphql. Also returns Error::UnexpectedResponse when data does not match T.

pub async fn shop_info(&self) -> Result<ShopInfo>

Read the shop name and domain. The health check uses it.

Errors

See query.

pub async fn subscribe_webhook( &self, topic: &str, callback_url: &str, ) -> Result<String>

Subscribe callback_url to topic (for example orders/create) with webhookSubscriptionCreate. Returns the subscription id.

The compliance topics are not in the GraphQL topic enum. Declare them in shopify.app.toml (compliance_topics).

Errors

Returns Error::InvalidRequest for a malformed topic and Error::Config for a compliance topic. See also query. Returns Error::GraphQl with the userErrors messages when Shopify refuses the subscription.

Trait Implementations

impl Clone for ShopifyClient

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShopifyClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.