Shopify API PHP Library

To start the OAuth flow, create a route (e.g., /login) that calls Shopify\Auth\OAuth::begin. This method returns a URL that redirects the user to the Shopify authentication screen.

Parameters

Custom Cookie Function Example (Yii Framework)

If you are using a framework like Yii, you must provide a custom function to ensure cookies are set correctly within the framework's response lifecycle:

function () use (Shopify\Auth\OAuthCookie $cookie) {
    $cookies = Yii::$app->response->cookies;
    $cookies->add(new \yii\web\Cookie([
        'name' => $cookie->getName(),
        'value' => $cookie->getValue(),
        'expire' => $cookie->getExpire(),
        'secure' => $cookie->isSecure(),
        'httpOnly' => $cookie->isSecure(),
    ]));

    return true;
}

The Shopify PHP library requires a session storage mechanism to handle OAuth information. While Shopify\Auth\FileSessionStorage is provided for rapid development, it is not suitable for production because it does not automatically clean up old session files, leading to disk build-up.

To prepare for production, you must implement the Shopify\Auth\SessionStorage interface using your preferred storage method (e.g., Redis, Database, or Memcached) and pass an instance of your implementation to Shopify\Context::initialize.

Important: Your implementation must include a mechanism to periodically clean up expired or old sessions from your storage, as the library cannot guarantee automatic deletion of all expired sessions.

// Example of how to pass your custom storage to the context
use Shopify\Context;
use Your\Custom\Namespace\MyProductionSessionStorage;

Context::initialize(
    $apiKey, 
    $apiSecret, 
    $scopes, 
    new MyProductionSessionStorage() // Your implementation of SessionStorage
);

To add a new API version (e.g., 2025-07) to the library, follow these steps:

1. Update API Version Constants

Edit src/ApiVersion.php to include the new version constant using the {MONTH}_{YEAR} naming convention and update the LATEST constant if this is the newest version.

2. Create Directory Structure

Create new directories for the source and test files using the Admin{YYYY_MM} format:

• Source: src/Rest/Admin{YYYY_MM}/
• Tests: tests/Rest/Admin{YYYY_MM}/

3. Copy and Update Resource Files

Copy all files from the most recent API version directory to the new directory. For every PHP file in the new directory, you must update:

• Namespace: Change to Shopify\Rest\Admin{NEW_VERSION}.
• API Version String: Update the public static string $API_VERSION property to the new version string.

4. Update Test Files

• Rename Files: Use the pattern {ResourceName}{YYYYMM}Test.php (e.g., Article202507Test.php).
• Update Imports: Update use statements to point to the new versioned namespace.
• Update Context: Set Context::$API_VERSION to the new version.
• Update Mock URLs: Update the version string in mock request URLs (e.g., .../admin/api/{NEW_VERSION}/...).

5. Handle Breaking Changes

• Removed Resources: Delete the resource file from src/Rest/Admin{NEW_VERSION}/ and its corresponding test file.
• Modified Resources: Update class properties, the $PATHS array, method signatures, and test cases to reflect changes in the Shopify API.

# Example: Adding version 2025_07

# 1. Update src/ApiVersion.php
# public const JULY_2025 = "2025-07";
# public const LATEST = self::JULY_2025;

# 2. Create directories
mkdir src/Rest/Admin2025_07/
tests/Rest/Admin2025_07/

# 3. Copy files from previous version (e.g., 2025_04)
cp -r src/Rest/Admin2025_04/* src/Rest/Admin2025_07/
cp -r tests/Rest/Admin2025_04/* tests/Rest/Admin2025_07/