常用API
常见的Admin API对象。
在这个部分
- 活动-商店活动的简要概述。
- ActivityTopic-活动的主题,用于显示适当的图标或默认图标。
- ApiVersion — API的版本。
- CountryCode -ISO 3166-1 alpha-2国家/地区代码,但有所不同。
- CropRegion —裁剪后应保留的图像部分。
- CurrencyCode —货币代码。
- 图像—表示图像资源。
- ImageContentType-支持的图像内容类型的列表。
- ImageInput —指定图像的输入字段。
- ImageUploadParameter —图像的上传参数。
- 作业-作业对应于客户端应轮询以了解状态的一些长期运行的任务。
- LegacyInteroperability —直接与REST Admin API资源相对应的类型的互操作性元数据。例如,在产品类型上,LegacyInteroperability返回REST Admin API中相应产品对象的元数据。
- MailingAddress-代表客户的邮寄地址。例如,客户的默认地址和订单的账单地址都是邮寄地址。
- MailingAddressInput —用于创建或更新邮件地址的字段。
- MoneyBag-以其各自货币表示的货币值的集合。
- MoneyInput —指定带有货币的货币值的字段。
- MoneyV2 —具有货币的货币值。要设置货币格式,请将此类型的数量和currencyCode字段与客户的区域设置结合使用。例如,在JavaScript中,您可以使用Intl.NumberFormat:
js new Intl.NumberFormat(locale, { style: ’currency’, currency: currencyCode }).format(amount);
其他格式库包括: iOS- NumberFormatter Android- NumberFormat * PHP- NumberFormatter对于更通用的解决方案,[Unicode CLDR数字格式数据库]可用于许多实现(例如作为TwitterCldr)。 - MutationsStagedUploadTargetGenerateUploadParameter —一个签名的上传参数,用于将资产上传到Shopify。
- 可浏览—用于分页的默认光标。默认光标可用于下一个和上一个导航。
- 节点—具有支持全局标识的ID的对象。
- QueryRoot —查询的架构的入口点。它充当公共的顶级API,所有查询都必须从该API开始。
- SavedSearch —保存的搜索表示保存在管理员中的搜索查询。
- SavedSearchCreateInput —指定创建保存的搜索所需的字段。
- SavedSearchDeleteInput-指定要删除已保存搜索的字段。
- SavedSearchUpdateInput —指定更新保存的搜索所需的字段。
- SearchFilter —搜索查询中由键值对表示的过滤器。
- SearchFilterOptions —搜索过滤器的列表以及它们在值和标签对中用于过滤的特定选项。
- SearchResult —表示从搜索返回的单个结果。
- SearchResultType-指定要从搜索返回的资源的类型。
- StageImageInput —要上传的图像。
- StagedUploadHttpMethodType —暂存上传目标的可能的HTTP方法。
- StagedUploadInput-要上传的媒体。
- StagedUploadParameter —媒体的上传参数。
- StagedUploadTarget-暂存的目标信息。
- StagedUploadTargetGenerateInput-指定生成URL所需的字段以及将资产上传到Shopify所需的参数。
- StagedUploadTargetGenerateUploadResource —指定要接收的资源类型。
- paymentAppConfigure —将合作伙伴托管网关配置到商人的商店。
- savedSearchCreate —创建一个保存的搜索。
- savedSearchDelete —删除保存的搜索。
- savedSearchUpdate —更新保存的搜索。
- stagedUploadTargetGenerate-生成将资产上传到Shopify所需的URL和签名的参数。
- stagedUploadTargetsGenerate-上传多个图像。
- stagedUploadsCreate-为每个输入创建分段的上载目标URL,这是上载过程的第一步。返回的带有URL的上载目标可用作上载文件的端点。
- tagsAdd —将标签添加到可标记对象。
- tagsRemove —从可标记对象中删除标记。