产品和馆藏API
使用产品和集合API访问和操作商店的目录。
在这个部分
- 渠道-渠道代表一个应用,您可以在其中销售一组产品和集合。渠道可以是平台或市场,例如Facebook或Pinterest,在线商店或POS。
- 集合—代表产品的集合。
- CollectionDeleteInput-指定要删除的集合。
- CollectionInput —指定创建集合所需的输入字段。
- CollectionPublication —表示发布集合的出版物。
- CollectionPublicationInput —指定要将集合发布到的发布。
- CollectionPublishInput —指定要发布的集合以及要发布到的销售渠道。
- CollectionRule —表示用于将产品分配给集合的规则。
- CollectionRuleColumn —指定用于填充智能集合的产品的属性。
- CollectionRuleConditions —集合可以使用规则来自动包括匹配的产品。这定义了对规则类型的限制。
- CollectionRuleInput —指定与集合关联的规则。
- CollectionRuleRelation —指定
column
和条件之间的关系。 - CollectionRuleSet-用于确定集合中包括哪些产品的规则集。
- CollectionRuleSetInput —指定集合的规则集。
- CollectionSortKeys —集合查询的有效排序键集。
- CollectionSortOrder —指定集合中产品的排序顺序。
- CollectionUnpublishInput —指定要取消发布的集合以及将其从中删除的销售渠道。
- CreateMediaInput-指定创建媒体对象所需的输入字段。
- ExternalVideo —表示在Shopify外部托管的视频。
- 媒体—一种自动生成的类型,用于通过多种媒体进行分页。
- MediaContentType —媒体对象的可能的内容类型。
- MediaImage —表示Shopify托管的图像。
- MediaPreviewImage —表示媒体的预览图像。
- MediaPreviewImageStatus —媒体预览图像的可能状态。
- MediaStatus —媒体对象的可能状态。
- Model3d —代表Shopify托管的3D模型。
- Model3dSource-表示Shopify托管3d模型的源。
- MoveInput —将对象执行到某个位置的单个移动。
- OnlineStorePreviewable —对象的在线商店预览URL。
- 产品—代表产品,包括有关相关集合和产品变体的信息。
- ProductAppendImagesInput-指定要附加的产品图像。
- ProductCollectionSortKeys — ProductCollection查询的一组有效排序键。
- ProductDeleteInput-指定要删除的产品。
- ProductImageSortKeys — ProductImage查询的有效排序键集。
- ProductInput —指定创建产品所需的输入字段。
- ProductMediaSortKeys — ProductMedia查询的有效排序键集。
- ProductOption —产品属性名称,例如“大小”,“颜色”和“材料”。根据这些选项的排列选择变体。最多255个字符。
- ProductPriceRange —产品的价格范围。
- ProductPriceRangeV2 —产品的价格范围。
- ProductPublication —代表发布产品的渠道。
- ProductPublicationInput —指定将产品发布到的发布。
- ProductPublishInput —指定要发布的产品以及将其发布到的渠道。
- ProductSortKeys —产品查询的一组有效排序键。
- ProductStatus —可能的产品状态。
- ProductUnpublishInput —指定要从渠道取消发布的产品,以及要从其取消发布的销售渠道。
- ProductVariant —代表产品变体。
- ProductVariantAppendMediaInput —指定将媒体附加到单个变量所需的输入字段。
- ProductVariantDetachMediaInput —指定从单个变量中分离媒体所需的输入字段。
- ProductVariantInput —指定要创建或更新的产品变体。
- ProductVariantInventoryManagement —产品变体的库存跟踪方法。
- ProductVariantInventoryPolicy —产品变体的库存策略控制着客户是否可以在缺货时继续购买变体。当值为时
continue
,客户可以在缺货时购买该变体。当值为时deny
,客户将在缺货时无法购买该变体。 - ProductVariantPricePair —比较价格和共享货币的变体的价格。
- ProductVariantSortKeys — ProductVariant查询的有效排序键集。
- PublicationInput —指定发布资源所需的输入字段。
- 可发布的-表示可以发布到频道的资源。可发布资源可以是产品或集合。
- ResourcePublication —资源发布表示资源已发布到发布。
- ResourcePublicationV2 —资源发布表示资源已经发布或将发布到发布。
- SelectedOption —客户用于选择产品变体的属性。产品可以有多种选择,例如不同的尺寸或颜色。
- SellingPlan-表示如何销售和购买产品。商家卸载其订阅应用程序后48小时,将删除销售计划和相关记录(销售计划组和策略)。如果您以后需要恢复它们,我们建议备份这些记录。
- SellingPlanAnchor-表示销售计划策略锚。
- SellingPlanAnchorInput-指定创建或更新销售计划锚所需的输入字段。
- SellingPlanAnchorType-表示锚点类型。
- SellingPlanBillingPolicy-表示与销售计划相关的开单频率(例如,每周开单或每三个月开单一次)。在商家卸载其订阅应用程序48小时后,将删除销售计划计费策略和相关记录(销售计划组,销售计划,定价策略和交付策略)。如果您以后需要恢复它们,我们建议备份这些记录。
- SellingPlanBillingPolicyInput-指定创建或更新计费策略类型所需的输入字段。
- SellingPlanDeliveryPolicy-表示与销售计划关联的交付频率(例如,每月交付或每隔一周交付一次)。在商家卸载其订阅应用程序后48小时,将删除销售计划交付策略和相关记录(销售计划组,销售计划,定价策略和计费策略)。如果您以后需要恢复它们,我们建议备份这些记录。
- SellingPlanDeliveryPolicyInput-指定用于创建或更新交付策略的输入字段。
- SellingPlanFixedPricingPolicy-表示固定的销售计划定价策略。
- SellingPlanFixedPricingPolicyInput-指定创建或更新固定销售计划定价策略所需的输入字段。
- SellingPlanGroup-表示一种销售方法(例如,“订阅并保存”或“预付费”)。商家卸载其订阅应用程序后48小时,将删除销售计划组和相关记录(销售计划和政策)。如果您以后需要恢复它们,我们建议备份这些记录。
- SellingPlanGroupInput-指定创建或更新销售计划组所需的输入字段。
- SellingPlanGroupResourceInput-指定与销售计划组的资源关联。
- SellingPlanGroupSortKeys -SellingPlanGroup查询的有效排序键集。
- SellingPlanInput-指定用于创建或更新销售计划的输入字段。
- SellingPlanInterval-表示有效的销售计划间隔。
- SellingPlanPricingPolicy-表示与销售计划相关的定价类型(例如,在有限时间内设置的10美元或20%的折扣,或者在订阅期间固定的折扣)。在商家卸载其订阅应用程序48小时后,将删除销售计划定价策略和相关记录(销售计划组,销售计划,计费策略和交付策略)。如果您以后需要恢复它们,我们建议备份这些记录。
- SellingPlanPricingPolicyAdjustmentType-表示销售计划定价策略调整类型。
- SellingPlanPricingPolicyAdjustmentValue-表示销售计划定价策略调整值类型。
- SellingPlanPricingPolicyBase-表示销售计划定价策略公用字段。
- SellingPlanPricingPolicyInput-指定创建或更新销售计划定价策略所需的输入字段。
- SellingPlanPricingPolicyPercentageValue-表示销售计划定价策略百分比类型的百分比值。
- SellingPlanPricingPolicyValueInput-指定创建或更新定价策略调整值所需的输入字段。
- SellingPlanRecurringBillingPolicy-表示定期销售计划开票策略。
- SellingPlanRecurringBillingPolicyInput-指定创建或更新定期计费策略所需的输入字段。
- SellingPlanRecurringDeliveryPolicy-表示重复销售计划交付策略。
- SellingPlanRecurringDeliveryPolicyInput-指定用于创建或更新定期交付策略的输入字段。
- SellingPlanRecurringDeliveryPolicyIntent-交付策略的可能意图。
- SellingPlanRecurringDeliveryPolicyPreAnchorBehavior —将订单放置在锚点之前时,第一个履行的可能履行或交付行为。
- SellingPlanRecurringPricingPolicy-表示重复销售计划定价策略。
- SellingPlanRecurringPricingPolicyInput-指定创建或更新定期销售计划定价策略所需的输入字段。
- StagedMediaUploadTarget-暂存媒体目标信息。
- UpdateMediaInput-指定更新媒体对象所需的输入字段。
- 视频—代表Shopify托管的视频。
- VideoSource —表示Shopify托管视频的源。
- 重量-表示重量单位和值。
- WeightInput —指定重量单位和值输入。
- WeightUnit —重量的度量单位。
- collectionAddProducts —将产品添加到集合中。
- collectionCreate —创建一个集合。
- collectionDelete —删除一个集合。
- collectionPublish —将集合发布到频道。
- collectionRemoveProducts —从给定集合中删除一组产品。运行可能需要很长时间。而不是返回集合,而是返回一个作业,该作业应进行轮询。
- collectionReorderProducts —从给定集合异步重新排序一组产品。
- collectionUnpublish —取消发布集合。
- collectionUpdate —更新集合。
- productAppendImages —将图像追加到产品。
- productChangeStatus —产品的更改状态。
- productCreate —创建产品。只能在订阅(
requiresSellingPlan: true
)上出售的产品只能在在线商店上创建。 - productCreateMedia —为产品创建媒体。
- productDelete —删除产品。
- productDeleteImages —从产品中删除产品图像。
- productDeleteMedia —删除产品的媒体。
- productDuplicate —复制产品。
- productImageUpdate —更新产品的图像。
- productJoinSellingPlanGroups —将多个销售计划组添加到一个产品。
- productLeaveSellingPlanGroups-从产品中删除多个组。
- productPublish —发布产品。仅在订阅(
requiresSellingPlan: true
)上出售的产品只能在在线商店上发布。 - productReorderImages —为给定产品异步重新排序一组图像。
- productReorderMedia —异步整理连接到产品的媒体。
- productUnpublish —取消发布产品。
- productUpdate —更新产品。只能在订阅(
requiresSellingPlan: true
)上出售的产品只能在在线商店上更新。如果您将产品更新为仅按订阅出售,那么该产品将在除在线商店之外的所有渠道中取消发布。 - productUpdateMedia —更新产品的媒体。
- productVariantAppendMedia —将媒体从产品追加到产品的变体。
- productVariantCreate —创建产品变体。
- productVariantDelete —删除产品变体。
- productVariantDetachMedia —从产品变型中删除媒体。
- productVariantJoinSellingPlanGroups-将多个销售计划组添加到产品变型中。
- productVariantLeaveSellingPlanGroups-从产品变型中删除多个组。
- productVariantUpdate —更新产品变体。
- publishablePublish —将资源发布到频道。如果资源是产品,则其状态必须为活动。仅在订阅(
requiresSellingPlan: true
)上出售的产品只能在在线商店上发布。 - publishablePublishToCurrentChannel —将资源发布到当前频道。如果资源是产品,则其状态必须为活动。仅在订阅(
requiresSellingPlan: true
)上出售的产品只能在在线商店上发布。 - publishableUnpublish —取消发布频道中的资源。如果资源是产品,则其状态必须为活动。
- publishableUnpublishToCurrentChannel —从当前频道取消发布资源。如果资源是产品,则其状态必须为活动。
- sellingPlanGroupAddProductVariants —将多个产品变体添加到销售计划组。
- sellingPlanGroupAddProducts —将多个产品添加到销售计划组。
- sellingPlanGroupCreate —创建一个销售计划组。
- sellingPlanGroupDelete —删除销售计划组。
- sellingPlanGroupRemoveProductVariants —从销售计划组中删除多个产品变体。
- sellingPlanGroupRemoveProducts —从销售计划组中删除多个产品。
- sellingPlanGroupUpdate —更新销售计划组。