https://github.com/channelape/shopify-sdk

Java SDK for Shopify REST APIs
https://github.com/channelape/shopify-sdk

client java-sdk orders products rest rest-api shopify shopify-api

Last synced: 5 days ago
JSON representation

Java SDK for Shopify REST APIs

• Host: GitHub
• URL: https://github.com/channelape/shopify-sdk
• Owner: ChannelApe
• License: apache-2.0
• Created: 2018-11-05T14:22:37.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-18T18:08:36.000Z (2 months ago)
• Last Synced: 2024-12-04T18:35:21.301Z (19 days ago)
• Topics: client, java-sdk, orders, products, rest, rest-api, shopify, shopify-api
• Language: Java
• Size: 793 KB
• Stars: 166
• Watchers: 18
• Forks: 112
• Open Issues: 40
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Shopify SDK

Java SDK for Shopify REST APIs

| Service   | Develop | Master |

|-----------|---------|--------|

| CI Status | ![example branch parameter](https://github.com/ChannelApe/shopify-sdk/actions/workflows/maven-develop.yml/badge.svg?branch=develop) | ![example branch parameter](https://github.com/ChannelApe/shopify-sdk/actions/workflows/maven.yml/badge.svg?branch=master) |

[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=com.channelape%3Ashopify-sdk&metric=alert_status)](https://sonarcloud.io/dashboard?id=com.channelape%3Ashopify-sdk) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=com.channelape%3Ashopify-sdk&metric=coverage)](https://sonarcloud.io/component_measures?id=com.channelape%3Ashopify-sdk&metric=coverage)

[![Maven Central](https://img.shields.io/maven-central/v/com.channelape/shopify-sdk.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.channelape%22%20AND%20a:%22shopify-sdk%22)

## Quickstart

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

```java

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](https://github.com/ChannelApe/shopify-sdk/releases)