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

DiscountCodeFreeShipping object

Version unstable

A free shipping code discount.

Required access

Apps must have read_discounts access scope.

Connections

  • A list of redeem codes for the discount.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • times_used

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    savedSearchId ( ID )

    ID of an existing saved search. The search’s query string is used as the query argument.

    sortKey ( DiscountCodeSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • appliesOnOneTimePurchase (Boolean!)

    Whether the discount applies on regular one-time-purchase shipping lines.

  • appliesOnSubscription (Boolean!)

    Whether the discount applies on subscription shipping lines.

  • appliesOncePerCustomer (Boolean!)

    Whether the discount can be applied only once per customer.

  • asyncUsageCount (Int!)

    The number of times that the discount has been used.

  • codeCount (Int!)

    The number of redeem codes for the discount.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerSelection (DiscountCustomerSelection!)

    The customers that can use the discount.

  • destinationSelection (DiscountShippingDestinationSelection!)

    A shipping destination that qualifies for the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • hasTimelineComment (Boolean!)

    Indicates whether there are any timeline comments on the discount.

  • maximumShippingPrice (MoneyV2)

    The maximum shipping price amount accepted to qualify for the discount.

  • minimumRequirement (DiscountMinimumRequirement)

    The minimum subtotal or quantity that's required for the discount to be applied.

  • recurringCycleLimit (Int)

    The number of times a discount applies on recurring purchases (subscriptions).

  • shareableUrls ([DiscountShareableUrl!]!)

    URLs that can be used to share the discount.

  • shortSummary (String!)

    A short summary of the discount.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.

  • summary (String!)

    A detailed summary of the discount.

  • title (String!)

    The title of the discount.

  • totalSales (MoneyV2)

    The total sales from orders where the discount was used.

  • usageLimit (Int)

    The maximum number of times that the discount can be used.

Mutations for DiscountCodeFreeShipping

Version 2021-04 (Release candidate)

A free shipping code discount.

Required access

Apps must have read_discounts access scope.

Connections

  • A list of redeem codes for the discount.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • times_used

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    savedSearchId ( ID )

    ID of an existing saved search. The search’s query string is used as the query argument.

    sortKey ( DiscountCodeSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • appliesOnOneTimePurchase (Boolean!)

    Whether the discount applies on regular one-time-purchase shipping lines.

  • appliesOnSubscription (Boolean!)

    Whether the discount applies on subscription shipping lines.

  • appliesOncePerCustomer (Boolean!)

    Whether the discount can be applied only once per customer.

  • asyncUsageCount (Int!)

    The number of times that the discount has been used.

  • codeCount (Int!)

    The number of redeem codes for the discount.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerSelection (DiscountCustomerSelection!)

    The customers that can use the discount.

  • destinationSelection (DiscountShippingDestinationSelection!)

    A shipping destination that qualifies for the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • hasTimelineComment (Boolean!)

    Indicates whether there are any timeline comments on the discount.

  • maximumShippingPrice (MoneyV2)

    The maximum shipping price amount accepted to qualify for the discount.

  • minimumRequirement (DiscountMinimumRequirement)

    The minimum subtotal or quantity that's required for the discount to be applied.

  • recurringCycleLimit (Int)

    The number of times a discount applies on recurring purchases (subscriptions).

  • shareableUrls ([DiscountShareableUrl!]!)

    URLs that can be used to share the discount.

  • shortSummary (String!)

    A short summary of the discount.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.

  • summary (String!)

    A detailed summary of the discount.

  • title (String!)

    The title of the discount.

  • totalSales (MoneyV2)

    The total sales from orders where the discount was used.

  • usageLimit (Int)

    The maximum number of times that the discount can be used.

Mutations for DiscountCodeFreeShipping

Version 2021-01 (Latest)

A free shipping code discount.

Required access

Apps must have read_discounts access scope.

Connections

  • A list of redeem codes for the discount.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • times_used

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    savedSearchId ( ID )

    ID of an existing saved search. The search’s query string is used as the query argument.

    sortKey ( DiscountCodeSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • appliesOnOneTimePurchase (Boolean!)

    Whether the discount applies on regular one-time-purchase shipping lines.

  • appliesOnSubscription (Boolean!)

    Whether the discount applies on subscription shipping lines.

  • appliesOncePerCustomer (Boolean!)

    Whether the discount can be applied only once per customer.

  • asyncUsageCount (Int!)

    The number of times that the discount has been used.

  • codeCount (Int!)

    The number of redeem codes for the discount.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerSelection (DiscountCustomerSelection!)

    The customers that can use the discount.

  • destinationSelection (DiscountShippingDestinationSelection!)

    A shipping destination that qualifies for the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • hasTimelineComment (Boolean!)

    Indicates whether there are any timeline comments on the discount.

  • maximumShippingPrice (MoneyV2)

    The maximum shipping price amount accepted to qualify for the discount.

  • minimumRequirement (DiscountMinimumRequirement)

    The minimum subtotal or quantity that's required for the discount to be applied.

  • recurringCycleLimit (Int)

    The number of times a discount applies on recurring purchases (subscriptions).

  • shareableUrls ([DiscountShareableUrl!]!)

    URLs that can be used to share the discount.

  • shortSummary (String!)

    A short summary of the discount.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.

  • summary (String!)

    A detailed summary of the discount.

  • title (String!)

    The title of the discount.

  • totalSales (MoneyV2)

    The total sales from orders where the discount was used.

  • usageLimit (Int)

    The maximum number of times that the discount can be used.

Mutations for DiscountCodeFreeShipping

Version 2020-10

A free shipping code discount.

Required access

Apps must have read_discounts access scope.

Connections

  • A list of redeem codes for the discount.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • times_used

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    savedSearchId ( ID )

    ID of an existing saved search. The search’s query string is used as the query argument.

    sortKey ( DiscountCodeSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • appliesOncePerCustomer (Boolean!)

    Whether the discount can be applied only once per customer.

  • asyncUsageCount (Int!)

    The number of times that the discount has been used.

  • codeCount (Int!)

    The number of redeem codes for the discount.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerSelection (DiscountCustomerSelection!)

    The customers that can use the discount.

  • destinationSelection (DiscountShippingDestinationSelection!)

    A shipping destination that qualifies for the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • hasTimelineComment (Boolean!)

    Indicates whether there are any timeline comments on the discount.

  • maximumShippingPrice (MoneyV2)

    The maximum shipping price amount accepted to qualify for the discount.

  • minimumRequirement (DiscountMinimumRequirement)

    The minimum subtotal or quantity that's required for the discount to be applied.

  • shareableUrls ([DiscountShareableUrl!]!)

    URLs that can be used to share the discount.

  • shortSummary (String!)

    A short summary of the discount.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.

  • summary (String!)

    A detailed summary of the discount.

  • title (String!)

    The title of the discount.

  • totalSales (MoneyV2)

    The total sales from orders where the discount was used.

  • usageLimit (Int)

    The maximum number of times that the discount can be used.

Mutations for DiscountCodeFreeShipping

Version 2020-07

A free shipping code discount.

Required access

Apps must have read_discounts access scope.

Connections

  • A list of redeem codes for the discount.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliesOncePerCustomer (Boolean!)

    Whether the discount can be applied only once per customer.

  • asyncUsageCount (Int!)

    The number of times that the discount has been used.

  • codeCount (Int!)

    The number of redeem codes for the discount.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerSelection (DiscountCustomerSelection!)

    The customers that can use the discount.

  • destinationSelection (DiscountShippingDestinationSelection!)

    A shipping destination that qualifies for the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • minimumRequirement (DiscountMinimumRequirement)

    The minimum subtotal or quantity that's required for the discount to be applied.

  • shortSummary (String!)

    A short summary of the discount.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.

  • summary (String!)

    A detailed summary of the discount.

  • title (String!)

    The title of the discount.

  • usageLimit (Int)

    The maximum number of times that the discount can be used.

Mutations for DiscountCodeFreeShipping

Version 2020-04

A free shipping code discount.

Required access

Apps must have read_discounts access scope.

Connections

  • A list of redeem codes for the discount.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliesOncePerCustomer (Boolean!)

    Whether the discount can be applied only once per customer.

  • asyncUsageCount (Int!)

    The number of times that the discount has been used.

  • codeCount (Int!)

    The number of redeem codes for the discount.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerSelection (DiscountCustomerSelection!)

    The customers that can use the discount.

  • destinationSelection (DiscountShippingDestinationSelection!)

    A shipping destination that qualifies for the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • minimumRequirement (DiscountMinimumRequirement)

    The minimum subtotal or quantity that's required for the discount to be applied.

  • shortSummary (String!)

    A short summary of the discount.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.

  • summary (String!)

    A detailed summary of the discount.

  • title (String!)

    The title of the discount.

  • usageLimit (Int)

    The maximum number of times that the discount can be used.

Mutations for DiscountCodeFreeShipping

Version 2020-01 (Unsupported)

A free shipping code discount.

Required access

Apps must have read_discounts access scope.

Connections

  • A list of redeem codes for the discount.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliesOncePerCustomer (Boolean!)

    Whether the discount can be applied only once per customer.

  • asyncUsageCount (Int!)

    The number of times that the discount has been used.

  • codeCount (Int!)

    The number of redeem codes for the discount.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerSelection (DiscountCustomerSelection!)

    The customers that can use the discount.

  • destinationSelection (DiscountShippingDestinationSelection!)

    A shipping destination that qualifies for the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • minimumRequirement (DiscountMinimumRequirement)

    The minimum subtotal or quantity that's required for the discount to be applied.

  • shortSummary (String!)

    A short summary of the discount.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.

  • summary (String!)

    A detailed summary of the discount.

  • title (String!)

    The title of the discount.

  • usageLimit (Int)

    The maximum number of times that the discount can be used.

Mutations for DiscountCodeFreeShipping

Version 2019-10 (Unsupported)

A free shipping code discount.

Required access

Apps must have read_discounts access scope.

Connections

  • A list of redeem codes for the discount.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliesOncePerCustomer (Boolean!)

    Whether the discount can be applied only once per customer.

  • asyncUsageCount (Int!)

    The number of times that the discount has been used.

  • codeCount (Int!)

    The number of redeem codes for the discount.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerSelection (DiscountCustomerSelection!)

    The customers that can use the discount.

  • destinationSelection (DiscountShippingDestinationSelection!)

    A shipping destination that qualifies for the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • minimumRequirement (DiscountMinimumRequirement)

    The minimum subtotal or quantity that's required for the discount to be applied.

  • shortSummary (String!)

    A short summary of the discount.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.

  • summary (String!)

    A detailed summary of the discount.

  • title (String!)

    The title of the discount.

  • usageLimit (Int)

    The maximum number of times that the discount can be used.

Mutations for DiscountCodeFreeShipping

Version 2019-07 (Unsupported)

A free shipping code discount.

Required access

Apps must have read_discounts access scope.

Connections

  • A list of redeem codes for the discount.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliesOncePerCustomer (Boolean!)

    Whether the discount can be applied only once per customer.

  • asyncUsageCount (Int!)

    The number of times that the discount has been used.

  • codeCount (Int!)

    The number of redeem codes for the discount.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerSelection (DiscountCustomerSelection!)

    The customers that can use the discount.

  • destinationSelection (DiscountShippingDestinationSelection!)

    A shipping destination that qualifies for the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • minimumRequirement (DiscountMinimumRequirement)

    The minimum subtotal or quantity that's required for the discount to be applied.

  • shortSummary (String!)

    A short summary of the discount.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.

  • summary (String!)

    A detailed summary of the discount.

  • title (String!)

    The title of the discount.

  • usageLimit (Int)

    The maximum number of times that the discount can be used.

Mutations for DiscountCodeFreeShipping

Version 2019-04 (Unsupported)

A free shipping code discount.

Required access

Apps must have read_discounts access scope.

Connections

  • A list of redeem codes for the discount.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliesOncePerCustomer (Boolean!)

    Whether the discount can be applied only once per customer.

  • asyncUsageCount (Int!)

    The number of times that the discount has been used.

  • codeCount (Int!)

    The number of redeem codes for the discount.

  • createdAt (DateTime!)

    The date and time when the discount was created.

  • customerSelection (DiscountCustomerSelection!)

    The customers that can use the discount.

  • destinationSelection (DiscountShippingDestinationSelection!)

    A shipping destination that qualifies for the discount.

  • endsAt (DateTime)

    The date and time when the discount ends. For open-ended discounts, use null.

  • minimumRequirement (DiscountMinimumRequirement)

    The minimum subtotal or quantity that's required for the discount to be applied.

  • shortSummary (String!)

    A short summary of the discount.

  • startsAt (DateTime!)

    The date and time when the discount starts.

  • status (DiscountStatus!)

    The status of the discount.

  • summary (String!)

    A detailed summary of the discount.

  • title (String!)

    The title of the discount.

  • usageLimit (Int)

    The maximum number of times that the discount can be used.

Mutations for DiscountCodeFreeShipping