API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

SellingPlanRecurringDeliveryPolicy object

Version unstable

Represents a recurring selling plan delivery policy.

Required access

Requires access to either all or app-owned selling plans.

On this page

Fields

anchors ([SellingPlanAnchor!]!)

Specific anchor dates upon which the delivery interval calculations should be made.

createdAt (DateTime!)

The date and time when the selling plan delivery policy was created.

cutoff (Int)

A buffer period for orders to be included in a cycle.

intent (SellingPlanRecurringDeliveryPolicyIntent!)

Specifies if 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!)

The delivery frequency, it can be either: day, week, month or year.

intervalCount (Int!)

The number of intervals between deliveries.

preAnchorBehavior (SellingPlanRecurringDeliveryPolicyPreAnchorBehavior!)

Fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP.

Version 2021-01 (Release candidate)

Represents a recurring selling plan delivery policy.

Required access

Requires access to either all or app-owned selling plans.

On this page

Fields

anchors ([SellingPlanAnchor!]!)

Specific anchor dates upon which the delivery interval calculations should be made.

createdAt (DateTime!)

The date and time when the selling plan delivery policy was created.

cutoff (Int)

A buffer period for orders to be included in a cycle.

intent (SellingPlanRecurringDeliveryPolicyIntent!)

Specifies if 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!)

The delivery frequency, it can be either: day, week, month or year.

intervalCount (Int!)

The number of intervals between deliveries.

preAnchorBehavior (SellingPlanRecurringDeliveryPolicyPreAnchorBehavior!)

Fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP.