README

PHPShopify 是 Shopify API 的简单 SDK 实现。它帮助以面向对象的方式访问 API。

安装

使用 Composer 安装

composer require phpclassic/php-shopify

要求

PHPShopify 使用 curl 扩展来处理 HTTP 请求。因此，您需要安装并启用 PHP 中的 curl 扩展。

但是，如果您更喜欢使用任何其他可用的处理 HTTP 请求的包库，您可以通过修改 PHPShopify\HttpRequestJson 类中的每个 get()、post()、put()、delete() 方法中的 1 行来实现。

您可以将额外的 curl 配置传递给 ShopifySDK

$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);

用法

您可以使用 PHPShopify 以一种相当简单面向对象的方式。

配置 ShopifySDK

如果您使用自己的私有 API，请提供 ApiKey 和密码。

$config = array(
    'ShopUrl' => 'yourshop.myshopify.com',
    'ApiKey' => '***YOUR-PRIVATE-API-KEY***',
    'Password' => '***YOUR-PRIVATE-API-PASSWORD***',
);

PHPShopify\ShopifySDK::config($config);

对于第三方应用，请使用永久访问令牌。

$config = array(
    'ShopUrl' => 'yourshop.myshopify.com',
    'AccessToken' => '***ACCESS-TOKEN-FOR-THIRD-PARTY-APP***',
);

PHPShopify\ShopifySDK::config($config);

如何获取商店的永久访问令牌？

有一个 AuthHelper 类可以帮助您通过 OAuth 从商店获取永久访问令牌。

首先，您需要使用额外的参数 SharedSecret 配置 SDK。

$config = array(
    'ShopUrl' => 'yourshop.myshopify.com',
    'ApiKey' => '***YOUR-PRIVATE-API-KEY***',
    'SharedSecret' => '***YOUR-SHARED-SECRET***',
);

PHPShopify\ShopifySDK::config($config);

创建身份验证请求

重定向 URL 必须在您的应用程序管理员中列为白名单之一，作为 应用程序重定向 URL 之一。

//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);

如果您希望函数返回身份验证 URL 而不是自动重定向，可以将参数 $return（第 5 个参数）设置为 true。

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

在应用程序授权后重定向回 $redirectUrl 时获取访问令牌。

//your_redirect_url.php
PHPShopify\ShopifySDK::config($config);
$accessToken = \PHPShopify\AuthHelper::getAccessToken();
//Now store it in database or somewhere else

您可以使用同一页面来创建请求和获取访问令牌（重定向 URL）。在这种情况下，只需在调用 createAuthRequest() 方法时跳过第二个参数 $redirectUrl。AuthHelper 类会为您完成剩余的操作。

//your_authorize_and_redirect_url.php
PHPShopify\ShopifySDK::config($config);
$accessToken = \PHPShopify\AuthHelper::createAuthRequest($scopes);
//Now store it in database or somewhere else

获取 ShopifySDK 对象

$shopify = new PHPShopify\ShopifySDK;

在实例化对象时，您可以提供配置作为参数（如果您还没有通过调用 config() 方法进行配置）

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

现在，您可以通过对象导向的方式调用资源进行 `get()`、`post()`、`put()`、`delete()` 调用。所有资源都使用与 Shopify API 参考中相同的名称。（见下面的资源映射。）

所有请求在成功时都会返回一个数组（可以是单个资源数组或多个资源的数组）。当不期望有结果时（例如 DELETE 请求），将返回一个空数组。

获取所有产品列表（GET 请求）

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

通过 ID 获取任何特定的产品（GET 请求）

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

您还可以使用 URL 参数（由 Shopify API 参考为每个特定资源指定）来过滤结果。

例如，获取指定日期和时间之后的已取消订单列表（fields 指定要渲染的每一行的数据列）

$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);

创建新的订单（POST 请求）

$order = array (
    "email" => "foo@example.com",
    "fulfillment_status" => "unfulfilled",
    "line_items" => [
      [
          "variant_id" => 27535413959,
          "quantity" => 5
      ]
    ]
);

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

请注意，您不需要将数据数组包裹在资源键（在这种情况下为 order）中，这是 Shopify API 预期的语法。这由本 SDK 自动处理。

更新订单（PUT 请求）

$updateInfo = array (
    "fulfillment_status" => "fulfilled",
);

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

删除 Webhook（DELETE 请求）

$webHookID = 453487303;

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

可以使用嵌套方式使用子资源。

在尝试获取任何子资源时，您必须提供父资源的 ID。

例如，获取产品的图像（GET 请求）

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

为顾客添加新地址（POST请求）

$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);

创建一个履行事件（POST请求）

$fulfillmentEvent = array(
    "status" => "in_transit"
);

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

更新博客文章（PUT请求）

$blogID = 23564666666;
$articleID = 125336666;
$updateArtilceInfo = array(
    "title" => "My new Title",
    "author" => "Your name",
    "tags" => "Tags, Will Be, Updated",
    "body_html" => "<p>Look, I can even update through a web service.<\/p>",
);
$shopify->Blog($blogID)->Article($articleID)->put($updateArtilceInfo);

删除特定博客中的任何特定文章（DELETE请求）

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

GraphQL ^版本1.1

GraphQL Admin API 是基于 GraphQL 的替代 REST-based Admin API，使得 Shopify 管理员的功能可以通过单个 GraphQL 端点提供。完整支持的类型可以在 GraphQL Admin API 参考文档中找到。您可以直接调用 GraphQL 资源，并使用 GraphQL 字符串进行 POST 请求。

GraphQL Admin API 需要访问令牌才能进行认证请求。您可以通过创建私有应用程序并使用该应用程序的 API 密码，或者通过遵循 OAuth 授权过程来获取访问令牌。请参阅 GraphQL 认证指南。

$graphQL = <<<Query
query {
  shop {
    name
    primaryDomain {
      url
      host
    }
  }
}
Query;

$data = $shopify->GraphQL->post($graphQL);

变量

如果您想使用 GraphQL 变量，您需要将变量放入数组中，并将其作为 post() 方法的第4个参数传递。第2和第3个参数在 GraphQL 中没有使用，但保留以保持与其他请求的相似性，您可以将这些设置为 null。以下是一个示例。

$graphQL = <<<Query
mutation ($input: CustomerInput!) {
  customerCreate(input: $input)
  {
    customer {
      id
      displayName
    }
    userErrors {
      field
      message
    }
  }
}
Query;

$variables = [
  "input" => [
    "firstName" => "Greg",
    "lastName" => "Variables",
    "email" => "gregvariables@teleworm.us"
  ]
]
$shopify->GraphQL->post($graphQL, null, null, $variables);

GraphQL 构建器

此 SDK 只接受 GraphQL 字符串作为输入。您可以从 Shopify GraphQL 构建器中构建您的 GraphQL。

资源映射

一些资源可以直接访问，一些资源只能通过父资源访问，而一些资源可以通过两种方式访问。建议您查看相关 Shopify API 参考页面中每个资源的详细信息。此处列出的每个资源名称都链接到相关的 Shopify API 参考页面。

仅通过列出的资源映射使用资源。尝试直接获取仅通过父资源可用的资源可能会导致错误。

AbandonedCheckout
ApplicationCharge
Blog
Blog -> Article
Blog -> Article -> Event
Blog -> Article -> Metafield
Blog -> Event
Blog -> Metafield
CarrierService-
Cart（只读）
Collect
Comment
Comment -> Event
Country
Country -> Province
Currency
CustomCollection
CustomCollection -> Event
CustomCollection -> Metafield
Customer
Customer -> Address
Customer -> Metafield
Customer -> Order
CustomerSavedSearch
CustomerSavedSearch -> Customer
DraftOrder
折扣 (仅限 Shopify Plus)
DiscountCode
Event
FulfillmentService
礼品卡 (仅限 Shopify Plus)
InventoryItem
InventoryLevel
位置 (只读)
位置 -> 库存水平
Metafield
Multipass (仅限 Shopify Plus，API 尚未提供)
Order
Order -> 履行
Order -> 履行 -> 事件
Order -> 风险
Order -> 退款
Order -> 交易
Order -> 事件
Order -> 元字段
Page
Page -> 事件
Page -> 元字段
策略 (只读)
Product
Product -> 图片
Product -> 变体
Product -> 变体 -> 元字段
Product -> 事件
Product -> 元字段
ProductListing
ProductVariant
ProductVariant -> 元字段
RecurringApplicationCharge
RecurringApplicationCharge -> 使用费用
Redirect
ScriptTag
配送区域 (只读)
商店 (只读)
SmartCollection
SmartCollection -> 事件
ShopifyPayment
ShopifyPayment -> 争议 (只读)
Theme
Theme -> 资产
用户 (只读，仅限 Shopify Plus)
Webhook
GraphQL

自定义操作

有几个操作方法可以在不直接调用 get()，post()，put()，delete() 方法的情况下调用，但最终会导致调用这些方法之一的自定义调用。

例如，获取总产品数

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

将地址设置为客户的默认地址。

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

搜索居住在美国的国家/地区且关键词为 "Bob" 的客户。

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

自定义操作列表

自定义方法针对某些资源，这些资源可能对其他资源不可用。建议您查看每个操作的 Shopify API 参考页面中的详细信息。这里仅列出可用的操作及其简要信息。每个操作名称都链接到 Shopify API 参考中的示例，其中包含更多详细信息。

(除 ApplicationCharge、CarrierService、FulfillmentService、Location、Policy、RecurringApplicationCharge、ShippingZone、Shop、Theme 以外的任何资源类型) ->
- count() 获取所有资源的数量。与其他所有操作不同，此函数返回一个整数值。
评论 ->
- markSpam() 将评论标记为垃圾邮件
- markNotSpam() 将评论标记为非垃圾邮件
- approve() 批准评论
- remove() 删除评论
- restore() 恢复评论
客户 ->
- search() 搜索符合提供的查询条件的客户
- send_invite($data) 向客户发送账户邀请。
客户 -> 地址 ->
- makeDefault() 将地址设置为客户的默认地址
- set($params) 对多个地址执行批量操作
草稿订单 ->
- send_invoice($data) 发送草稿订单的发票
- complete($data) 完成草稿订单
折扣 ->
- enable() 启用折扣
- disable() 禁用折扣
折扣代码 ->
- lookup($data) 检索折扣代码的位置。
履约 ->
- complete() 完成履约
- open() 打开待处理的履约
- cancel() 取消履约
礼品卡 ->
- disable() 禁用礼品卡。
- search() 搜索符合提供的查询条件的礼品卡
库存水平 ->
- adjust($data) 调整库存水平。
- connect($data) 将库存项目连接到位置。
- set($data) 设置位置内单个库存项目的库存水平。
订单 ->
- close() 关闭订单
- open() 重新打开已关闭的订单
- cancel($data) 取消订单
订单 -> 退款 ->
- calculate() 计算退款
产品列表 ->
- productIds() 获取发布到您的应用程序的产品ID
周期性应用费用 ->
- activate() 激活周期性应用费用
- customize($data) 定制周期性应用费用
智能收藏夹 ->
- sortOrder($params) 设置智能收藏夹中产品的排序类型和/或手动顺序
用户 ->
- current() 获取当前登录用户

Shopify API 功能头

在使用SDK时发送 X-Shopify-Api-Features 头部，可以使用以下方法

$config['ShopifyApiFeatures'] = ['include-presentment-prices'];
$shopify = new PHPShopify\ShopifySDK($config);

参考

Shopify API 参考文档

付费支持

您可以为使用PHPShopify SDK设置您的项目雇佣此SDK的作者。

在Upwork上雇佣

资助者

通过每月捐赠支持我们，帮助我们继续活动。[成为资助者]

赞助商

成为赞助商，并在我们的Github README上放置您的标志，并链接到您的网站。[成为赞助商]

automit2021 / php-shopify

维护者

详情

README

安装

要求

用法

配置 ShopifySDK

如何获取商店的永久访问令牌？

获取 ShopifySDK 对象

现在，您可以通过对象导向的方式调用资源进行 `get()`、`post()`、`put()`、`delete()` 调用。所有资源都使用与 Shopify API 参考中相同的名称。（见下面的资源映射。）

可以使用嵌套方式使用子资源。

GraphQL ^版本1.1

变量

GraphQL 构建器

资源映射

自定义操作

自定义操作列表

Shopify API 功能头

参考

付费支持

资助者

赞助商

automit2021 / php-shopify

维护者

详情

README

安装

要求

用法

配置 ShopifySDK

如何获取商店的永久访问令牌？

获取 ShopifySDK 对象

现在，您可以通过对象导向的方式调用资源进行 get()、post()、put()、delete() 调用。所有资源都使用与 Shopify API 参考中相同的名称。（见下面的资源映射。）

可以使用嵌套方式使用子资源。

GraphQL 版本1.1

变量

GraphQL 构建器

资源映射

自定义操作

自定义操作列表

Shopify API 功能头

参考

付费支持

资助者

赞助商

现在，您可以通过对象导向的方式调用资源进行 `get()`、`post()`、`put()`、`delete()` 调用。所有资源都使用与 Shopify API 参考中相同的名称。（见下面的资源映射。）

GraphQL ^版本1.1