Choose a version:

SellingPlanDeliveryPolicy

union

Requires read_products access scope.

Represents the delivery frequency associated to the selling plan (for example, deliver every month, or deliver every other week). The selling plan delivery policy and associated records (selling plan groups, selling plans, pricing policies, and billing policy) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.

Anchor to Possible typesPossible types

SellingPlanFixedDeliveryPolicy

•

OBJECT

Represents a fixed selling plan delivery policy.

anchors• [SellingPlanAnchor!]! non-null: The specific anchor dates upon which the delivery interval calculations should be made.
cutoff• Int: A buffer period for orders to be included in next fulfillment anchor.
fulfillmentExactTime• DateTime: The date and time when the fulfillment should trigger.
fulfillmentTrigger• SellingPlanFulfillmentTrigger! non-null: What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN.
intent• SellingPlanFixedDeliveryPolicyIntent! non-null: Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported.
preAnchorBehavior• SellingPlanFixedDeliveryPolicyPreAnchorBehavior! non-null: The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP.

SellingPlanRecurringDeliveryPolicy

•

OBJECT

Represents a recurring selling plan delivery policy.

anchors• [SellingPlanAnchor!]! non-null: The specific anchor dates upon which the delivery interval calculations should be made.
createdAt• DateTime! non-null: The date and time when the selling plan delivery policy was created.
cutoff• Int: Number of days which represent a buffer period for orders to be included in a cycle.
intent• SellingPlanRecurringDeliveryPolicyIntent! non-null: Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported.
interval• SellingPlanInterval! non-null: The delivery frequency, it can be either: day, week, month or year.
intervalCount• Int! non-null: The number of intervals between deliveries.
preAnchorBehavior• SellingPlanRecurringDeliveryPolicyPreAnchorBehavior! non-null: The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to SellingPlan.deliveryPolicy SellingPlan.deliveryPolicy • OBJECT: A selling plan policy which describes the delivery details.

Was this section helpful?