Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/phpclassic/php-shopify

PHP SDK for Shopify API
https://github.com/phpclassic/php-shopify

php-sdk php-shopify shopify shopify-api shopify-sdk

Last synced: 1 day ago
JSON representation

PHP SDK for Shopify API

Awesome Lists containing this project

README 

        
# PHP Shopify SDK



[![Build Status](https://travis-ci.org/phpclassic/php-shopify.svg?branch=master)](https://travis-ci.org/phpclassic/php-shopify) [![Monthly Downloads](https://poser.pugx.org/phpclassic/php-shopify/d/monthly)](https://packagist.org/packages/phpclassic/php-shopify) [![Total Downloads](https://poser.pugx.org/phpclassic/php-shopify/downloads)](https://packagist.org/packages/phpclassic/php-shopify) [![Latest Stable Version](https://poser.pugx.org/phpclassic/php-shopify/v/stable)](https://packagist.org/packages/phpclassic/php-shopify) [![Latest Unstable Version](https://poser.pugx.org/phpclassic/php-shopify/v/unstable)](https://packagist.org/packages/phpclassic/php-shopify) [![License](https://poser.pugx.org/phpclassic/php-shopify/license)](https://packagist.org/packages/phpclassic/php-shopify) [![Hire](https://img.shields.io/badge/Hire-Upwork-green.svg)](https://www.upwork.com/fl/tareqmahmood?s=1110580755107926016)



PHPShopify is a simple SDK implementation of Shopify API. It helps accessing the API in an object oriented way. 



## Installation

Install with Composer

```shell

composer require phpclassic/php-shopify

```



### Requirements

PHPShopify uses curl extension for handling http calls. So you need to have the curl extension installed and enabled with PHP.

>However if you prefer to use any other available package library for handling HTTP calls, you can easily do so by modifying 1 line in each of the `get()`, `post()`, `put()`, `delete()` methods in `PHPShopify\HttpRequestJson` class.



You can pass additional curl configuration to `ShopifySDK`

```php

$config = array(

    'ShopUrl' => 'yourshop.myshopify.com',

    'ApiKey' => '***YOUR-PRIVATE-API-KEY***',

    'Password' => '***YOUR-PRIVATE-API-PASSWORD***',   

    'Curl' => array(

        CURLOPT_TIMEOUT => 10,

        CURLOPT_FOLLOWLOCATION => true

    )

);



PHPShopify\ShopifySDK::config($config);

```

## Usage



You can use PHPShopify in a pretty simple object oriented way. 



#### Configure ShopifySDK

If you are using your own private API (except GraphQL), provide the ApiKey and Password. 



```php

$config = array(

    'ShopUrl' => 'yourshop.myshopify.com',

    'ApiKey' => '***YOUR-PRIVATE-API-KEY***',

    'Password' => '***YOUR-PRIVATE-API-PASSWORD***',

);



PHPShopify\ShopifySDK::config($config);

```



For Third party apps, use the permanent access token. 

> For GraphQL, AccessToken is required. If you are using private API for GraphQL, use your password as AccessToken here.



```php

$config = array(

    'ShopUrl' => 'yourshop.myshopify.com',

    'AccessToken' => '***ACCESS-TOKEN-FOR-THIRD-PARTY-APP***',

);



PHPShopify\ShopifySDK::config($config);

```

You can use specific Shopify API Version by adding in the config array



```php

$config = array(

    'ShopUrl' => 'yourshop.myshopify.com',

    'AccessToken' => '***ACCESS-TOKEN-FOR-THIRD-PARTY-APP***',

    'ApiVersion' => '2022-07',

);



PHPShopify\ShopifySDK::config($config);

```

##### How to get the permanent access token for a shop?

There is a AuthHelper class to help you getting the permanent access token from the shop using oAuth. 



1) First, you need to configure the SDK with additional parameter SharedSecret



```php

$config = array(

    'ShopUrl' => 'yourshop.myshopify.com',

    'ApiKey' => '***YOUR-PRIVATE-API-KEY***',

    'SharedSecret' => '***YOUR-SHARED-SECRET***',

);



PHPShopify\ShopifySDK::config($config);

```



2) Create the authentication request 



> The redirect url must be white listed from your app admin as one of **Application Redirect URLs**.



```php

//your_authorize_url.php

$scopes = 'read_products,write_products,read_script_tags,write_script_tags';

//This is also valid

//$scopes = array('read_products','write_products','read_script_tags', 'write_script_tags'); 

$redirectUrl = 'https://yourappurl.com/your_redirect_url.php';



\PHPShopify\AuthHelper::createAuthRequest($scopes, $redirectUrl);

```



> If you want the function to return the authentication url instead of auto-redirecting, you can set the argument `$return` (5th argument) to `true`.



```php

\PHPShopify\AuthHelper::createAuthRequest($scopes, $redirectUrl, null, null, true);

```



3) Get the access token when redirected back to the `$redirectUrl` after app authorization. 



```php

//your_redirect_url.php

PHPShopify\ShopifySDK::config($config);

$accessToken = \PHPShopify\AuthHelper::getAccessToken();

//Now store it in database or somewhere else

```



> You can use the same page for creating the request and getting the access token (redirect url). In that case just skip the 2nd parameter `$redirectUrl` while calling `createAuthRequest()` method. The AuthHelper class will do the rest for you.



```php

//your_authorize_and_redirect_url.php

PHPShopify\ShopifySDK::config($config);

$accessToken = \PHPShopify\AuthHelper::createAuthRequest($scopes);

//Now store it in database or somewhere else

```



#### Get the ShopifySDK Object



```php

$shopify = new PHPShopify\ShopifySDK;

```



You can provide the configuration as a parameter while instantiating the object (if you didn't configure already by calling `config()` method)



```php

$shopify = new PHPShopify\ShopifySDK($config);

```



##### Now you can do `get()`, `post()`, `put()`, `delete()` calling the resources in the object oriented way. All resources are named as same as it is named in shopify API reference. (See the resource map below.) 

> All the requests returns an array (which can be a single resource array or an array of multiple resources) if succeeded. When no result is expected (for example a DELETE request), an empty array will be returned.



- Get all product list (GET request)



```php

$products = $shopify->Product->get();

```



- Get any specific product with ID (GET request)



```php

$productID = 23564666666;

$product = $shopify->Product($productID)->get();

```



You can also filter the results by using the url parameters (as specified by Shopify API Reference for each specific resource). 



- For example get the list of cancelled orders after a specified date and time (and `fields` specifies the data columns for each row to be rendered) : 



```php

$params = array(

    'status' => 'cancelled',

    'created_at_min' => '2016-06-25T16:15:47-04:00',

    'fields' => 'id,line_items,name,total_price'

);



$orders = $shopify->Order->get($params);

```



- Create a new order (POST Request)



```php

$order = array (

    "email" => "[email protected]",

    "fulfillment_status" => "unfulfilled",

    "line_items" => [

      [

          "variant_id" => 27535413959,

          "quantity" => 5

      ]

    ]

);



$shopify->Order->post($order);

```



> Note that you don't need to wrap the data array with the resource key (`order` in this case), which is the expected syntax from Shopify API. This is automatically handled by this SDK.



- Update an order (PUT Request)



```php

$updateInfo = array (

    "fulfillment_status" => "fulfilled",

);



$shopify->Order($orderID)->put($updateInfo);

```



- Remove a Webhook (DELETE request)



```php

$webHookID = 453487303;



$shopify->Webhook($webHookID)->delete();

```



### The child resources can be used in a nested way.

> You must provide the ID of the parent resource when trying to get any child resource



- For example, get the images of a product (GET request)



```php

$productID = 23564666666;

$productImages = $shopify->Product($productID)->Image->get();

```



- Add a new address for a customer (POST Request)



```php

$address = array(

    "address1" => "129 Oak St",

    "city" => "Ottawa",

    "province" => "ON",

    "phone" => "555-1212",

    "zip" => "123 ABC",

    "last_name" => "Lastnameson",

    "first_name" => "Mother",

    "country" => "CA",

);



$customerID = 4425749127;



$shopify->Customer($customerID)->Address->post($address);

```



- Create a fulfillment event (POST request)



```php

$fulfillmentEvent = array(

    "status" => "in_transit"

);



$shopify->Order($orderID)->Fulfillment($fulfillmentID)->Event->post($fulfillmentEvent);

```



- Update a Blog article (PUT request)



```php

$blogID = 23564666666;

$articleID = 125336666;

$updateArtilceInfo = array(

    "title" => "My new Title",

    "author" => "Your name",

    "tags" => "Tags, Will Be, Updated",

    "body_html" => "
Look, I can even update through a web service.<\/p>",

);

$shopify->Blog($blogID)->Article($articleID)->put($updateArtilceInfo);

```



- Delete any specific article from a specific blog (DELETE request)



```php

$blogArticle = $shopify->Blog($blogID)->Article($articleID)->delete();

```



### GraphQL *v1.1*

The GraphQL Admin API is a GraphQL-based alternative to the REST-based Admin API, and makes the functionality of the Shopify admin available at a single GraphQL endpoint. The full set of supported types can be found in the [GraphQL Admin API reference](https://help.shopify.com/en/api/graphql-admin-api/reference).

You can simply call the GraphQL resource and make a post request with a GraphQL string:



> The GraphQL Admin API requires an access token for making authenticated requests. You can obtain an access token either by creating a private app and using that app's API password, or by following the OAuth authorization process. See [GraphQL Authentication Guide](https://help.shopify.com/en/api/graphql-admin-api/getting-started#authentication)



```php

$graphQL = <<GraphQL->post($graphQL);

```

##### Variables

If you want to use [GraphQL variables](https://shopify.dev/concepts/graphql/variables), you need to put the variables in an array and give it as the 4th argument of the `post()` method. The 2nd and 3rd arguments don't have any use in GraphQL, but are there to keep similarity with other requests, you can just keep those as `null`. Here is an example: 



```php

$graphQL = << [

    "firstName" => "Greg",

    "lastName" => "Variables",

    "email" => "[email protected]"

  ]

]

$shopify->GraphQL->post($graphQL, null, null, $variables);

```



##### GraphQL Builder

This SDK only accepts a GraphQL string as input. You can build your GraphQL from [Shopify GraphQL Builder](https://help.shopify.com/en/api/graphql-admin-api/graphiql-builder)



### Resource Mapping

Some resources are available directly, some resources are only available through parent resources and a few resources can be accessed both ways. It is recommended that you see the details in the related Shopify API Reference page about each resource. Each resource name here is linked to related Shopify API Reference page.

> Use the resources only by listed resource map. Trying to get a resource directly which is only available through parent resource may end up with errors.



- [AbandonedCheckout](https://help.shopify.com/api/reference/abandoned_checkouts)

- [ApiDeprecations](https://shopify.dev/api/admin-rest/2022-04/resources/deprecated-api-calls#get-deprecated-api-calls)

- [ApplicationCharge](https://help.shopify.com/api/reference/applicationcharge)

- [AssignedFulfillmentOrder](https://shopify.dev/docs/api/admin-rest/2023-04/resources/assignedfulfillmentorder)

- [Blog](https://help.shopify.com/api/reference/blog/)

- Blog -> [Article](https://help.shopify.com/api/reference/article/)

- Blog -> Article -> [Event](https://help.shopify.com/api/reference/event/)

- Blog -> Article -> [Metafield](https://help.shopify.com/api/reference/metafield)

- Blog -> [Event](https://help.shopify.com/api/reference/event/)

- Blog -> [Metafield](https://help.shopify.com/api/reference/metafield)

- [CarrierService](https://help.shopify.com/api/reference/carrierservice/)-

- [Cart](https://shopify.dev/docs/themes/ajax-api/reference/cart) (read only)

- [Collect](https://help.shopify.com/api/reference/collect/)

- [Comment](https://help.shopify.com/api/reference/comment/)

- Comment -> [Event](https://help.shopify.com/api/reference/event/)

- [Country](https://help.shopify.com/api/reference/country/)

- Country -> [Province](https://help.shopify.com/api/reference/province/)

- [Currency](https://help.shopify.com/en/api/reference/store-properties/currency)

- [CustomCollection]()

- CustomCollection -> [Event](https://help.shopify.com/api/reference/event/)

- CustomCollection -> [Metafield](https://help.shopify.com/api/reference/metafield)

- [Customer](https://help.shopify.com/api/reference/customer/)

- Customer -> [Address](https://help.shopify.com/api/reference/customeraddress/)

- Customer -> [Metafield](https://help.shopify.com/api/reference/metafield)

- Customer -> [Order](https://help.shopify.com/api/reference/order)

- [CustomerSavedSearch](https://help.shopify.com/api/reference/customersavedsearch/)

- CustomerSavedSearch -> [Customer](https://help.shopify.com/api/reference/customer/)

- [DraftOrder](https://help.shopify.com/api/reference/draftorder)

- [Discount](https://help.shopify.com/api/reference/discount) _(Shopify Plus Only)_

- [DiscountCode](https://help.shopify.com/en/api/reference/discounts/discountcode)

- [Event](https://help.shopify.com/api/reference/event/)

- [FulfillmentService](https://help.shopify.com/api/reference/fulfillmentservice)

- [Fulfillment](https://shopify.dev/api/admin-rest/2023-01/resources/fulfillment)

- [FulfillmentOrder](https://shopify.dev/api/admin-rest/2023-01/resources/fulfillmentorder)

- FulfillmentOrder -> [FulfillmentRequest](https://shopify.dev/api/admin-rest/2023-01/resources/fulfillmentrequest)

- FulfillmentOrder -> [Fulfillment](https://shopify.dev/api/admin-rest/2023-01/resources/fulfillment)

- [GiftCard](https://help.shopify.com/api/reference/gift_card) _(Shopify Plus Only)_

- GiftCard -> [Adjustment](https://shopify.dev/docs/api/admin-rest/2023-01/resources/gift-card-adjustment) _(Shopify Plus Only)_

- [InventoryItem](https://help.shopify.com/api/reference/inventoryitem)

- [InventoryLevel](https://help.shopify.com/api/reference/inventorylevel)

- [Location](https://help.shopify.com/api/reference/location/) _(read only)_

- Location -> [InventoryLevel](https://help.shopify.com/api/reference/inventorylevel)

- Location -> [Metafield](https://help.shopify.com/api/reference/metafield)

- [Metafield](https://help.shopify.com/api/reference/metafield)

- [Multipass](https://help.shopify.com/api/reference/multipass) _(Shopify Plus Only, API not available yet)_

- [Order](https://help.shopify.com/api/reference/order)

- Order -> [FulfillmentOrder](https://shopify.dev/api/admin-rest/2023-01/resources/fulfillmentorder)

- Order -> [Risk](https://help.shopify.com/api/reference/order_risks)

- Order -> [Refund](https://help.shopify.com/api/reference/refund)

- Order -> [Transaction](https://help.shopify.com/api/reference/transaction)

- Order -> [Event](https://help.shopify.com/api/reference/event/)

- Order -> [Metafield](https://help.shopify.com/api/reference/metafield)

- [Page](https://help.shopify.com/api/reference/page)

- Page -> [Event](https://help.shopify.com/api/reference/event/)

- Page -> [Metafield](https://help.shopify.com/api/reference/metafield)

- [Policy](https://help.shopify.com/api/reference/policy) _(read only)_

- [Product](https://help.shopify.com/api/reference/product)

- Product -> [Image](https://help.shopify.com/api/reference/product_image)

- Product -> [Variant](https://help.shopify.com/api/reference/product_variant)

- Product -> Variant -> [Metafield](https://help.shopify.com/api/reference/metafield)

- Product -> [Event](https://help.shopify.com/api/reference/event/)

- Product -> [Metafield](https://help.shopify.com/api/reference/metafield)

- [ProductListing](https://help.shopify.com/api/reference/sales_channels/productlisting)

- [ProductVariant](https://help.shopify.com/api/reference/product_variant)

- ProductVariant -> [Metafield](https://help.shopify.com/api/reference/metafield)

- [RecurringApplicationCharge](https://help.shopify.com/api/reference/recurringapplicationcharge)

- RecurringApplicationCharge -> [UsageCharge](https://help.shopify.com/api/reference/usagecharge)

- [Redirect](https://help.shopify.com/api/reference/redirect)

- [ScriptTag](https://help.shopify.com/api/reference/scripttag)

- [ShippingZone](https://help.shopify.com/api/reference/shipping_zone) _(read only)_

- [Shop](https://help.shopify.com/api/reference/shop) _(read only)_

- [SmartCollection](https://help.shopify.com/api/reference/smartcollection)

- SmartCollection -> [Event](https://help.shopify.com/api/reference/event/)

- [ShopifyPayment](https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/)

- ShopifyPayment -> [Dispute](https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/dispute/) _(read only)_

- [Theme](https://help.shopify.com/api/reference/theme)

- Theme -> [Asset](https://help.shopify.com/api/reference/asset/)

- [User](https://help.shopify.com/api/reference/user) _(read only, Shopify Plus Only)_

- [Webhook](https://help.shopify.com/api/reference/webhook)

- [GraphQL](https://help.shopify.com/en/api/graphql-admin-api/reference)



### Custom Actions

There are several action methods which can be called without calling the `get()`, `post()`, `put()`, `delete()` methods directly, but eventually results in a custom call to one of those methods.



- For example, get count of total products

```php

$productCount = $shopify->Product->count();

```



- Make an address default for the customer.

```php

$shopify->Customer($customerID)->Address($addressID)->makeDefault();

```



- Search for customers with keyword "Bob" living in country "United States".

```php

$shopify->Customer->search("Bob country:United States");

```



#### Custom Actions List

The custom methods are specific to some resources which may not be available for other resources.  It is recommended that you see the details in the related Shopify API Reference page about each action. We will just list the available actions here with some brief info. each action name is linked to an example in Shopify API Reference which has more details information.



- (Any resource type except _ApplicationCharge, CarrierService, FulfillmentService, Location, Policy, RecurringApplicationCharge, ShippingZone, Shop, Theme_) ->

    - [count()](https://help.shopify.com/api/reference/product#count)

    Get a count of all the resources.

    Unlike all other actions, this function returns an integer value.



- Comment ->

    - [markSpam()](https://help.shopify.com/api/reference/comment#spam)

    Mark a Comment as spam

    - [markNotSpam()](https://help.shopify.com/api/reference/comment#not_spam)

    Mark a Comment as not spam

    - [approve()](https://help.shopify.com/api/reference/comment#approve)

    Approve a Comment

    - [remove()](https://help.shopify.com/api/reference/comment#remove)

    Remove a Comment

    - [restore()](https://help.shopify.com/api/reference/comment#restore)

    Restore a Comment

    

- Customer ->

    - [search()](https://help.shopify.com/api/reference/customer#search)

    Search for customers matching supplied query

    - [send_invite($data)](https://help.shopify.com/en/api/reference/customers/customer#send_invite)

    Sends an account invite to a customer.

    

- Customer -> Address ->

    - [makeDefault()](https://help.shopify.com/api/reference/customeraddress#default)

    Sets the address as default for the customer

    - [set($params)](https://help.shopify.com/api/reference/customeraddress#set)

    Perform bulk operations against a number of addresses

    

- DraftOrder ->

    - [send_invoice($data)]()

    Send the invoice for a DraftOrder

    - [complete($data)]()

    Complete a DraftOrder

    

- Discount ->

    - [enable()]()

    Enable a discount

    - [disable()]()

    Disable a discount

    

- DiscountCode ->

    - [lookup($data)]()

    Retrieves the location of a discount code.    

    

- Fulfillment ->

    - [complete()](https://help.shopify.com/api/reference/fulfillment#complete)

    Complete a fulfillment

    - [open()](https://help.shopify.com/api/reference/fulfillment#open)

    Open a pending fulfillment

    - [cancel()](https://help.shopify.com/api/reference/fulfillment#cancel)

    Cancel a fulfillment

    

- GiftCard ->

    - [disable()](https://help.shopify.com/api/reference/gift_card#disable)

    Disable a gift card.

    - [search()](https://help.shopify.com/api/reference/gift_card#search)

    Search for gift cards matching supplied query

    

- InventoryLevel ->

    - [adjust($data)](https://help.shopify.com/api/reference/inventorylevel#adjust)

    Adjust inventory level.

    - [connect($data)](https://help.shopify.com/api/reference/inventorylevel#connect)

    Connect an inventory item to a location.

    - [set($data)](https://help.shopify.com/api/reference/inventorylevel#set)

    Set an inventory level for a single inventory item within a location.

    

- Order ->

    - [close()](https://help.shopify.com/api/reference/order#close)

    Close an Order

    - [open()](https://help.shopify.com/api/reference/order#open)

    Re-open a closed Order

    - [cancel($data)](https://help.shopify.com/api/reference/order#cancel)

    Cancel an Order



- Order -> Refund ->

    - [calculate()](https://help.shopify.com/api/reference/refund#calculate)

    Calculate a Refund.

    

- ProductListing ->

    - [productIds()](https://help.shopify.com/api/reference/sales_channels/productlisting#product_ids)

    Retrieve product_ids that are published to your app.

    

- RecurringApplicationCharge -> 

    - [activate()](https://help.shopify.com/api/reference/recurringapplicationcharge#activate)

    Activate a recurring application charge

    - [customize($data)](https://help.shopify.com/api/reference/recurringapplicationcharge#customize)

    Customize a recurring application charge

    

- SmartCollection -> 

    - [sortOrder($params)](https://help.shopify.com/api/reference/smartcollection#order)

    Set the ordering type and/or the manual order of products in a smart collection

    

- User ->

    - [current()](https://help.shopify.com/api/reference/user#current)

    Get the current logged-in user

    

### FulfillmentRequest Resource - including actions

- Mapped FulfillmentOrder->FulfillmentRequest

- Mapped Order(id)->FulfillmentOrder



```php

// Requesting the FulfilmentOrder for a given order

$fo = $client->Order("1234567890")->FulfillmentOrder()->get();



// Requesting assigned fulfillment orders (with status fulfillment_requested)

$shopify->AssignedFulfillmentOrder()->get(["assignment_status" => "fulfillment_requested"]);



// Creating a FulfilmentRequest

// Follow instructions to get partial fulfilments

$fr = $client->FulfillmentOrder('0987654321')->FulfillmentRequest->post([]);



// Accepting \ Rejecting a FulfilmentRequest

$fr = $client->FulfillmentOrder('0987654321')->FulfillmentRequest->accept();

$fr = $client->FulfillmentOrder('0987654321')->FulfillmentRequest->reject();



// Communicating fulfillment

$client->Fulfillment->post($body)

```



### Shopify API features headers

To send `X-Shopify-Api-Features` headers while using the SDK, you can use the following:



```

$config['ShopifyApiFeatures'] = ['include-presentment-prices'];

$shopify = new PHPShopify\ShopifySDK($config);

```



## Reference

- [Shopify API Reference](https://help.shopify.com/api/reference/)



## Paid Support

You can hire the author of this SDK for setting up your project with PHPShopify SDK. 



[Hire at Upwork](https://www.upwork.com/fl/tareqmahmood?s=1110580755107926016)



## Backers



Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/phpshopify#backer)]
































































## Sponsors



Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/phpshopify#sponsor)]