Cmdlets for Shopify

Build 24.0.9060

AppSubscriptions

Lists all subscriptions created for a shop on the installed application.

Table-Specific Information

Select

The cmdlet uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The cmdlet processes other filters client-side within the cmdlet.

  • AppInstallationId supports the '=,IN' comparison operators.

For example, the following queries are processed server side:

  SELECT * FROM AppSubscriptions
  SELECT * FROM AppSubscriptions WHERE AppInstallationId = 'Val1'

Insert

The following columns can be used to create a new record:

Name, Test, ReturnUrl, TrialDays

The following pseudo-column can be used to create a new record (the value of inputs that reference another table can be entered as #TEMP tables):

LineItem (references AppSubscriptionLineItems)

Delete

You can delete entries by specifying the following column:

Id

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A globally-unique ID.

AppInstallationId String True

A globally-unique ID.

Name String True

The name of the app subscription.

Status String True

The status of the app subscription.

Test Bool True

Specifies whether the app subscription is a test transaction.

ReturnUrl String True

The URL that the merchant is redirected to after approving the app subscription.

TrialDays Int True

The number of free trial days, starting at the subscription's creation date, by which billing is delayed.

CurrentPeriodEnd Datetime True

The date and time when the current app subscription period ends. Returns 'null' if the subscription isn't active.

CreatedAt Datetime True

The date and time when the app subscription was created.

LineItemIds String True

The IDs of the plans attached to the app subscription.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements, to offer a more granular control over the tuples that are returned from the data source, or as parameters in INSERT statements.

Name Type Description
LineItem String

LineItem

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060