search

ChannelApe / shopify-sdk

Java SDK for Shopify REST APIs
Apache License 2.0
166 stars 112 forks source link
client java-sdk orders products rest rest-api shopify shopify-api

readme

Shopify SDK

Java SDK for Shopify REST APIs

Service Develop Master
CI Status example branch parameter example branch parameter

Quality Gate Coverage Maven Central

Quickstart

Creating SDK with store subdomain and access token, then making a sample call:

final ShopifySdk shopifySdk = ShopifySdk.newBuilder()
  .withSubdomain(subdomain)
  .withAccessToken(accessToken).build();
final ShopifyShop shopifyShop = shopifySdk.getShop();

For private apps, accessToken should be the private app's Admin API password.

Optional Configuration

The final parameters of the SDK builder are optional and will use default values when not supplied:

Parameter Description Default
Minimum Request Retry Random Delay Shopify SDK uses a random wait strategy when calculating to perform the next attempt. This is the minimum duration to wait before performing the failed request. 1 second
Maximum Request Retry Random Delay Shopify SDK uses a random wait strategy when calculating to perform the next attempt. This is the maximum duration to wait before performing the failed request. 5 seconds
Maximum Request Retry Timeout The maximum time to keep retrying failed requests. 3 minutes
Connection Timeout The duration to attempt to connect to Shopify's API. 1 minute
Read Timeout The duration to attempt to read a response from Shopify's API. 15 Seconds

Building from source

1. Install Maven
2. Install JDK 8
3. Clone the repository.
3. Navigate to repository directory and run `mvn install`

Release Notes

Please see our release notes here: https://github.com/ChannelApe/shopify-sdk/releases