Common APIs

Common Admin API objects.

In this section

  • Activity — Succinct overview of a shop activity.

  • ActivityTopic — The topic of the activity, used to display an appropriate icon or a default icon.

  • ApiVersion — A version of the API.

  • CountryCode — ISO 3166-1 alpha-2 country codes with some differences.

  • CropRegion — The part of the image that should remain after cropping.

  • CurrencyCode — Currency codes.

  • Image — Represents an image resource.

  • ImageContentType — List of supported image content types.

  • ImageInput — Specifies the input fields for an image.

  • ImageUploadParameter — Upload parameter of an image.

  • Job — A job corresponds to some long running task that the client should poll for status.

  • LegacyInteroperability — Interoperability metadata for types that directly correspond to a REST Admin API resource. For example, on the Product type, LegacyInteroperability returns metadata for the corresponding Product object in the REST Admin API.

  • MailingAddress — Represents a customer mailing address. For example, a customer’s default address and an order’s billing address are both mailling addresses.

  • MailingAddressInput — The fields used to create or update a mailing address.

  • MetafieldSchemaInput — Specifies the input fields for a MetafieldSchema.

  • MetafieldSchemaOwnerType — Metafield schema owner types and their count of metafield schemas under a shop.

  • MoneyBag — A collection of monetary values in their respective currencies.

  • MoneyInput — Specifies the fields for a monetary value with currency.

  • MoneyV2 — A monetary value with currency. To format currencies, combine this type’s amount and currencyCode fields with your client’s locale. For example, in JavaScript you could use Intl.NumberFormat: js new Intl.NumberFormat(locale, { style: ’currency’, currency: currencyCode }).format(amount); Other formatting libraries include: * iOS - NumberFormatter * Android - NumberFormat * PHP - NumberFormatter For a more general solution, the [Unicode CLDR number formatting database] is available with many implementations (such as TwitterCldr).

  • MutationsStagedUploadTargetGenerateUploadParameter — A signed upload parameter for uploading an asset to Shopify.

  • Navigable — A default cursor for use in pagination. The default cursor can be used for next and previous navigation.

  • Node — An object with an ID to support global identification.

  • QueryRoot — The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.

  • SavedSearch — A saved search is a representation of a search query saved in the admin.

  • SavedSearchCreateInput — Specifies the fields required to create a saved search.

  • SavedSearchDeleteInput — Specifies the fields to delete a saved search.

  • SavedSearchUpdateInput — Specifies the fields required to update a saved search.

  • SearchFilter — A filter in a search query represented by a key value pair.

  • SearchFilterOptions — A list of search filters along with their specific options in value and label pair for filtering.

  • SearchResult — Represents an individual result returned from a search.

  • SearchResultType — Specifies the type of resources to be returned from a search.

  • StageImageInput — Image to be uploaded.

  • StagedUploadHttpMethodType — Possible HTTP method of a staged upload target.

  • StagedUploadInput — Media to be uploaded.

  • StagedUploadParameter — Upload parameter of a Media.

  • StagedUploadTarget — Staged target information.

  • StagedUploadTargetGenerateInput — Specifies the fields required to generate the URL and parameters needed to upload an asset to Shopify.

  • StagedUploadTargetGenerateUploadResource — Specifies the resource type to receive.

  • metafieldSchemaCreate — Creates a metafield schema.

  • paymentsAppConfigure — Configure the partner managed gateway onto the merchant’s store.

  • savedSearchCreate — Creates a saved search.

  • savedSearchDelete — Delete a saved search.

  • savedSearchUpdate — Update a saved search.

  • stagedUploadTargetGenerate — Generates the URL and signed paramaters needed to upload an asset to Shopify.

  • stagedUploadTargetsGenerate — Uploads multiple images.

  • stagedUploadsCreate — Creates staged upload target URLs for each input and is the first step in the upload process. The returned upload targets with URLs can be used as endpoints to upload the files.

  • tagsAdd — Add tags to a taggable object.

  • tagsRemove — Remove tags from a taggable object.