PHPackages                             jonaswebdev/shopify-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. jonaswebdev/shopify-api

ActiveLibrary[API Development](/categories/api)

jonaswebdev/shopify-api
=======================

Shopify API Library for PHP

0291PHP

Since Sep 1Pushed 2y agoCompare

[ Source](https://github.com/jonaswebdev/shopify-api-php)[ Packagist](https://packagist.org/packages/jonaswebdev/shopify-api)[ RSS](/packages/jonaswebdev-shopify-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Shopify API Library for PHP
===========================

[](#shopify-api-library-for-php)

[![License: MIT](https://camo.githubusercontent.com/784362b26e4b3546254f1893e778ba64616e362bd6ac791991d2c9e880a3a64e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d677265656e2e737667)](LICENSE)

This library provides support for PHP [Shopify](https://www.shopify.com) apps to access the [Shopify Admin API](https://shopify.dev/docs/api/admin), by making it easier to perform the following actions:

- Creating [online](https://shopify.dev/docs/apps/auth#online-access) or [offline](https://shopify.dev/docs/apps/auth#offline-access) access tokens for the Admin API via OAuth
- Making requests to the [REST API](https://shopify.dev/docs/api/admin-rest)
- Making requests to the [GraphQL API](https://shopify.dev/docs/api/admin-graphql)
- Registering/processing webhooks

In addition to the Admin API, this library also allows querying the [Storefront API](https://shopify.dev/docs/api/storefront).

This library can be used in any application that has a PHP backend, since it doesn't rely on any specific framework—you can include it alongside your preferred stack and only use the features that you need to build your app.

Requirements
============

[](#requirements)

To follow these usage guides, you will need to:

- have a basic understanding of [PHP](https://php.net)
- have a Shopify Partner account and development store
- *OR* have a test store where you can create a private app
- have a private or custom app already set up in your test store or partner account
- use [ngrok](https://ngrok.com), in order to create a secure tunnel to your app running on your localhost
- add the `ngrok` URL and the appropriate redirect for your OAuth callback route to your app settings

Getting started
===============

[](#getting-started)

You can follow our [getting started guide](docs/) to learn how to use this library's components.

- [Getting started](docs/getting_started.md)
    - [Install dependencies](docs/getting_started.md#install-dependencies)
    - [Set up the library](docs/getting_started.md#set-up-the-library)
- [Performing OAuth](docs/usage/oauth.md)
    - [Begin OAuth](docs/usage/oauth.md#begin-oauth)
    - [OAuth callback](docs/usage/oauth.md#oauth-callback)
- [REST Admin API](docs/usage/rest.md)
- [Make a GraphQL API call](docs/usage/graphql.md)
- [Make a Storefront API call](docs/usage/storefront.md)
- [Webhooks](docs/usage/webhooks.md)
- [Utilities](docs/usage/utils.md)
- [Known issues and caveats](docs/issues.md)
    - [Notes on session handling](docs/issues.md#notes-on-session-handling)

Developing this library
=======================

[](#developing-this-library)

After cloning the repository, composer can install the dependencies:

```
composer install

```

To run tests:

```
composer test

```

If you want to get a code coverage report from the tests, you'll need to install the `php-xdebug` extension by running `pecl install xdebug`, and then run:

```
composer test -- [--coverage-text|--coverage-html=]

```

You may have to clear composer's autoload cache when namespaces change:

```
composer dump-autoload

```

To run linter:

```
composer lint

```

After having modified the `composer.json` file, make sure to run:

```
composer validate
composer normalize

```

###  Health Score

17

—

LowBetter than 6% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity21

Early-stage or recently created project

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/d9ee46d93c1177ab520bd96fed17fa87c93a6bd48d9d8f670a568c47066801dd?d=identicon)[jonaswebdev](/maintainers/jonaswebdev)

---

Top Contributors

[![paulomarg](https://avatars.githubusercontent.com/u/64600052?v=4)](https://github.com/paulomarg "paulomarg (174 commits)")[![Paulinakhew](https://avatars.githubusercontent.com/u/40904028?v=4)](https://github.com/Paulinakhew "Paulinakhew (95 commits)")[![mkevinosullivan](https://avatars.githubusercontent.com/u/56687600?v=4)](https://github.com/mkevinosullivan "mkevinosullivan (23 commits)")[![Jan0707](https://avatars.githubusercontent.com/u/1663330?v=4)](https://github.com/Jan0707 "Jan0707 (13 commits)")[![carmelal](https://avatars.githubusercontent.com/u/54586536?v=4)](https://github.com/carmelal "carmelal (10 commits)")[![jonaswebdev](https://avatars.githubusercontent.com/u/1163141?v=4)](https://github.com/jonaswebdev "jonaswebdev (9 commits)")[![andershagbard](https://avatars.githubusercontent.com/u/9662430?v=4)](https://github.com/andershagbard "andershagbard (7 commits)")[![andyw8](https://avatars.githubusercontent.com/u/13400?v=4)](https://github.com/andyw8 "andyw8 (7 commits)")[![klenotiw](https://avatars.githubusercontent.com/u/54754550?v=4)](https://github.com/klenotiw "klenotiw (6 commits)")[![uliandim](https://avatars.githubusercontent.com/u/9256324?v=4)](https://github.com/uliandim "uliandim (6 commits)")[![dersam](https://avatars.githubusercontent.com/u/475851?v=4)](https://github.com/dersam "dersam (5 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (4 commits)")[![fredden](https://avatars.githubusercontent.com/u/334786?v=4)](https://github.com/fredden "fredden (3 commits)")[![JaKXz](https://avatars.githubusercontent.com/u/2642545?v=4)](https://github.com/JaKXz "JaKXz (2 commits)")[![pacocastrotech](https://avatars.githubusercontent.com/u/100367169?v=4)](https://github.com/pacocastrotech "pacocastrotech (2 commits)")[![tanema](https://avatars.githubusercontent.com/u/463193?v=4)](https://github.com/tanema "tanema (2 commits)")[![thecodepixi](https://avatars.githubusercontent.com/u/16492325?v=4)](https://github.com/thecodepixi "thecodepixi (2 commits)")[![yuliandimitrov](https://avatars.githubusercontent.com/u/70013538?v=4)](https://github.com/yuliandimitrov "yuliandimitrov (1 commits)")[![connor11528](https://avatars.githubusercontent.com/u/3578908?v=4)](https://github.com/connor11528 "connor11528 (1 commits)")[![cursedcoder](https://avatars.githubusercontent.com/u/899452?v=4)](https://github.com/cursedcoder "cursedcoder (1 commits)")

### Embed Badge

![Health badge](/badges/jonaswebdev-shopify-api/health.svg)

```
[![Health](https://phpackages.com/badges/jonaswebdev-shopify-api/health.svg)](https://phpackages.com/packages/jonaswebdev-shopify-api)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
