Shop Minis Admin API
The Shop Minis Admin API is only available to early access partners. Apply here to join the early access program.
The Shop Minis Admin API is a GraphQL API that allows developers or backend applications to communicate with the Shop Minis platform. It can be used to check eligibility information about shops and products, configure entry points, query for attribution data and more.
If you're an early access partner, we'll have provided you with an API key to get started. Your API key is secret and should never be shared with or exposed in client-side contexts. If you don't already have an API key, you can request one in the partners issue tracker.
Here's an example for making authenticated requests to the Shop Minis Admin API using curl:
curl -X POST \
https://server.shop.app/minis/admin-api/alpha/graphql.json \
-H 'Content-Type: application/graphql' \
-H 'Authorization: Bearer <shop-minis-admin-api-key>' \
-d '{your_query}'
The application/graphql content type is only required when the request body is a GraphQL query string. If you are using a dedicated GraphQL client it should use application/json instead.
You can see detailed information about the GraphQL schema below, or explore the API at the following endpoint:
https://server.shop.app/minis/admin-api/alpha/graphql.json
Rate limiting
The Shop Minis Admin API is rate limited. You are unlikely to experience throttling during the normal operation of your Shop Mini, but if you plan to make many requests in quick succession (e.g. backfilling entry points) you should take rate limiting into account. Requests that are subject to throttling will have a response status code of 429 and include a top-level error with the code TOO_MANY_REQUESTS:
{
"data": null,
"errors": [
{
"message": "Slow down there partner.",
"extensions": {
"code": "TOO_MANY_REQUESTS"
}
}
]
}
Table of Contents
- Query
- Mutation
- Objects
- Attribution
- AttributionConnection
- AttributionEdge
- AttributionField
- ContentCreator
- DefaultCardEntryPoint
- DevelopmentStore
- DevelopmentStoreConnection
- DevelopmentStoreEdge
- EntryPointConnection
- EntryPointDeleteAllPayload
- EntryPointDeleteAllUserError
- EntryPointDeleteByOwnerPayload
- EntryPointDeleteByOwnerUserError
- EntryPointDeleteByRulePayload
- EntryPointDeleteByRuleUserError
- EntryPointEdge
- EntryPointEventStatusUpdatePayload
- EntryPointEventStatusUpdateUserError
- EntryPointSetByOwnerPayload
- EntryPointSetByOwnerUserError
- EntryPointSetByRulePayload
- EntryPointSetByRuleUserError
- EntryPointVisibilityRuleValidity
- EntryPointVisibilityRuleValidityUserError
- EventCardV2EntryPoint
- ExternalVideo
- Image
- ImageCollectionEntryPoint
- ImageCollectionEntryPointItem
- ImageCollectionV2EntryPoint
- ImageCollectionV2EntryPointItem
- ImageCollectionV2EntryPointItemRelatedProduct
- InvitationAcceptPayload
- InvitationAcceptUserError
- LinkEntryPoint
- Mini
- MiniTogglePayload
- MoneyV2
- NotificationTriggerPayload
- NotificationTriggerUserError
- PageInfo
- ProductEligibility
- ProductOfferCardEntryPoint
- ShopEligibility
- StagedUpload
- Submission
- SubmissionCancelPayload
- SubmissionCancelUserError
- SubmissionConnection
- SubmissionCreatePayload
- SubmissionCreateUserError
- SubmissionEdge
- SubmissionUploadCreatePayload
- SubmissionUploadCreateUserError
- VideoCollectionEntryPoint
- VideoCollectionEntryPointItem
- VideoCollectionV2EntryPoint
- VideoCollectionV2EntryPointContentCreator
- VideoCollectionV2EntryPointItem
- VideoCollectionV2EntryPointRelatedProduct
- Warning
- Inputs
- ContentCreatorInput
- DefaultCardEntryPointSetInput
- EntryPointSetInput
- EventCardV2EntryPointSetInput
- ExternalVideoInput
- ImageCollectionEntryPointItemInput
- ImageCollectionEntryPointSetInput
- ImageCollectionV2EntryPointItemInput
- ImageCollectionV2EntryPointItemRelatedProductInput
- ImageCollectionV2EntryPointSetInput
- ImageInput
- LinkEntryPointSetInput
- MoneyInput
- ProductOfferCardEntryPointSetInput
- StagedUploadInput
- TimeRangeFilter
- VideoCollectionEntryPointItemInput
- VideoCollectionEntryPointSetInput
- VideoCollectionV2EntryPointItemInput
- VideoCollectionV2EntryPointItemRelatedProductInput
- VideoCollectionV2EntryPointSetInput
- Enums
- CurrencyCode
- EntryPointDeleteAllUserErrorCode
- EntryPointDeleteByOwnerUserErrorCode
- EntryPointDeleteByRuleUserErrorCode
- EntryPointEventStatus
- EntryPointEventStatusUpdateUserErrorCode
- EntryPointLocation
- EntryPointSetByOwnerUserErrorCode
- EntryPointSetByRuleUserErrorCode
- EntryPointType
- EntryPointVisibilityRuleValidityErrorCode
- EntryPointVisibilityRuleValidityStatus
- EventCardV2EntryPointEventStatus
- ImageCollectionEntryPointLayout
- InvitationAcceptUserErrorCode
- NotificationTriggerUserErrorCode
- ProductEligibilityStatus
- ShopEligibilityStatus
- SubmissionCancelUserErrorCode
- SubmissionCreateUserErrorCode
- SubmissionStatus
- SubmissionUploadCreateUserErrorCode
- Scalars
- Interfaces
Query
| Field | Argument | Type | Description |
|---|---|---|---|
| attributions | AttributionConnection! | Returns attributions for orders made through a Mini within Shop. | |
| shopDomain | String | The domain of the shop ({store_name}.myshopify.com) to get attributions for. | |
| orderId | ID | The ID of the order to get attributions for. | |
| after | String | Returns the elements in the list that come after the specified cursor. | |
| before | String | Returns the elements in the list that come before the specified cursor. | |
| first | Int | Returns the first n elements from the list. | |
| last | Int | Returns the last n elements from the list. | |
| developmentStores | DevelopmentStoreConnection! | Returns development stores for the Shop Mini. | |
| after | String | Returns the elements in the list that come after the specified cursor. | |
| before | String | Returns the elements in the list that come before the specified cursor. | |
| first | Int | Returns the first n elements from the list. | |
| last | Int | Returns the last n elements from the list. | |
| entryPointVisibilityRuleValidity | EntryPointVisibilityRuleValidity! | Returns whether a given entry point visibility rule is valid. | |
| rule | String! | The rule to check. | |
| entryPoints | EntryPointConnection! | Returns a list of entry points given the filters. | |
| shopDomain | String! | Filters entry points only for this shop domain. | |
| location | EntryPointLocation | Filters only entry points for this location. Empty indicates all locations will be returned. | |
| type | EntryPointType | Filters only entry points with this type. Empty indicates all types will be returned. | |
| updatedAt | TimeRangeFilter | Shows entry points updated within a date range. | |
| first | Int | Returns the first n elements from the list. | |
| after | String | Returns the elements in the list that come after the specified cursor. | |
| before | String | Returns the elements in the list that come before the specified cursor. | |
| last | Int | Returns the last n elements from the list. | |
| mini | Mini | Returns information about a Mini based on the provided API key. | |
| productEligibilities | [ProductEligibility!]! | Returns eligibilities for products within Shop. | |
| productIds | [ID!]! | The IDs of the products to get eligibilities for. | |
| shopEligibilities | [ShopEligibility!]! | Returns eligibilities for shops within Shop. | |
| shopDomains | [String!] | The domains of the shops ({store_name}.myshopify.com) to get eligibilities for. | |
| submissions | SubmissionConnection! | Returns submissions for the Shop Mini. | |
| after | String | Returns the elements in the list that come after the specified cursor. | |
| before | String | Returns the elements in the list that come before the specified cursor. | |
| first | Int | Returns the first n elements from the list. | |
| last | Int | Returns the last n elements from the list. | |
Mutation
| Field | Argument | Type | Description |
|---|---|---|---|
| entryPointDeleteAll | EntryPointDeleteAllPayload! | Asynchronously deletes all entry points for the given shopDomain. Entry points created or updated after performing the mutation will not be deleted. | |
| shopDomain | String! | The shop domain for which to delete all entry points. | |
| entryPointDeleteByOwner | EntryPointDeleteByOwnerPayload! | Deletes an entry point by using its ownerId. | |
| location | EntryPointLocation! | The location of the entry point. | |
| type | EntryPointType! | The type of the entry point. | |
| ownerId | ID! | The Shop ID, Product ID or Order ID which the entry point belongs to. | |
| entryPointDeleteByRule | EntryPointDeleteByRulePayload! | Deletes an entry point with a visibility rule. | |
| shopDomain | String! | The Shop domain to which entry point belongs. | |
| location | EntryPointLocation! | The location of the entry point. | |
| type | EntryPointType! | The type of the entry point. | |
| entryPointEventStatusUpdate | EntryPointEventStatusUpdatePayload! | Updates the status of an event entry point. | |
| shopDomain | String | The Shop domain ({store_name}.myshopify.com) to which the entry point event details belong. | |
| productId | ID | The Product ID to which entry point event details belongs. | |
| status | EntryPointEventStatus! | The status value to be used for event entry point. | |
| entryPointSetByOwner | EntryPointSetByOwnerPayload! | Creates or updates an entry point. | |
| shopDomain | String | The Shop domain to which entry point belongs. | |
| location | EntryPointLocation! | The location of the entry point. | |
| ownerId | ID! | The owner ID for the relevant product, shop, or order. | |
| input | EntryPointSetInput! | The entry point input. | |
| entryPointSetByRule | EntryPointSetByRulePayload! | Creates or updates entry point by setting a visibility rule. | |
| shopDomain | String! | The Shop domain to which the entry points belong. | |
| location | EntryPointLocation! | The location of the entry point. | |
| visibilityRule | String! | The visibility rule which calculates where entry points should appear e.g. tag:tag-1 OR tag:tag-2. | |
| input | EntryPointSetInput! | The entry point input. | |
| invitationAccept | InvitationAcceptPayload! | Swap an invitation code for an API key. | |
| code | String! | The invitation code. | |
| miniToggle | MiniTogglePayload! | Enables or disables the Mini by partner. | |
| enable | Boolean! | The flag to enable or disable Mini. | |
| notificationTrigger | NotificationTriggerPayload! | Triggers a notification. | |
| templateHandle | String! | The template used for the notification. | |
| shopDomain | String | The Shop domain ({store_name}.myshopify.com) related to the notification. | |
| scopedEntityId | ID! | The subject of notification, Shop ID or Product ID. | |
| submissionCancel | SubmissionCancelPayload! | Cancels a pending submission. | |
| reference | String! | Reference of the submission to be cancelled. | |
| submissionCreate | SubmissionCreatePayload! | Creates a new submission. | |
| description | String! | A description of the Shop Mini and any changes since the last released version. | |
| uploadId | ID! | The ID of the staged upload to attach to the submission. | |
| submissionUploadCreate | SubmissionUploadCreatePayload! | Creates a new staged upload for a submission. | |
| input | StagedUploadInput! | The information needed to create a new staged upload. | |
Objects
Attribution
Represents attribution details for a line item in an order.
| Field | Argument | Type | Description |
|---|---|---|---|
| fields | [AttributionField!]! | The fields associated with this attribution. | |
| lineItemId | ID! | The LineItem ID associated with this attribution. | |
| orderId | ID! | The Order ID associated with this attribution. | |
| shopDomain | String! | The Shop domain ({store_name}.myshopify.com) associated with this attribution. | |
| shopId ⚠️ | ID! | The Shop ID associated with this attribution. ⚠️ DEPRECATED
| |
AttributionConnection
The connection type for Attribution.
| Field | Argument | Type | Description |
|---|---|---|---|
| edges | [AttributionEdge!]! | A list of edges. | |
| nodes | [Attribution!]! | A list of nodes. | |
| pageInfo | PageInfo! | Information to aid in pagination. | |
AttributionEdge
An edge in a connection.
| Field | Argument | Type | Description |
|---|---|---|---|
| cursor | String! | A cursor for use in pagination. | |
| node | Attribution | The item at the end of the edge. | |
AttributionField
Represents a single attribution detail.
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | The key of the field. | |
| value | String! | The value of the field. | |
ContentCreator
This is a content creator that may appear next to a Mini entry point.
| Field | Argument | Type | Description |
|---|---|---|---|
| avatar | Image | The avatar of the content creator. | |
| name | String! | The name of the content creator. | |
DefaultCardEntryPoint
This is a default card entry point for the Minis Admin API.
| Field | Argument | Type | Description |
|---|---|---|---|
| actionText | String | The action text of the entry point. | |
| id | ID | The ID of the entry point. | |
| image | Image | The image for the entry point. | |
| location | EntryPointLocation | The location of the entry point. | |
| ownerId | ID | The ID of the owner of the entry point. Empty indicates the entry point has multiple owners set by the | |
| text | String | The text of the entry point. | |
| title | String! | The title of the entry point. | |
| updatedAt | ISO8601DateTime! | The date and time when the entry point was updated. | |
| visibilityRule | String | The visibility rule of the entry point. Empty indicates the entry point has a single owner set by the | |
DevelopmentStore
A development store for a Shop Mini.
| Field | Argument | Type | Description |
|---|---|---|---|
| shareUrl | String | An user-attributed URL used for sharing the shop with others. | |
| shopDomain | String! | The domain of the development store. | |
| shopId | ID! | The shop ID of the development store. | |
DevelopmentStoreConnection
The connection type for DevelopmentStore.
| Field | Argument | Type | Description |
|---|---|---|---|
| edges | [DevelopmentStoreEdge!]! | A list of edges. | |
| nodes | [DevelopmentStore!]! | A list of nodes. | |
| pageInfo | PageInfo! | Information to aid in pagination. | |
DevelopmentStoreEdge
An edge in a connection.
| Field | Argument | Type | Description |
|---|---|---|---|
| cursor | String! | A cursor for use in pagination. | |
| node | DevelopmentStore | The item at the end of the edge. | |
EntryPointConnection
The connection type for EntryPoint.
| Field | Argument | Type | Description |
|---|---|---|---|
| edges | [EntryPointEdge] | A list of edges. | |
| nodes | [EntryPoint] | A list of nodes. | |
| pageInfo | PageInfo! | Information to aid in pagination. | |
EntryPointDeleteAllPayload
Return type for the entryPointDeleteAll mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| userErrors | [EntryPointDeleteAllUserError!]! | List of errors that occured while executing the mutation. | |
EntryPointDeleteAllUserError
A user or client error that could occur during the execution of the entryPointDeleteAll mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | EntryPointDeleteAllUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
EntryPointDeleteByOwnerPayload
Return type for the entryPointDeleteByOwner mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| userErrors | [EntryPointDeleteByOwnerUserError!]! | List of errors that occured while executing the mutation. | |
EntryPointDeleteByOwnerUserError
A user or client error that could occur during the execution of the entryPointDeleteByOwner mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | EntryPointDeleteByOwnerUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
EntryPointDeleteByRulePayload
Return type for the entryPointDeleteByRule mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| userErrors | [EntryPointDeleteByRuleUserError!]! | List of errors that occured while executing the mutation. | |
EntryPointDeleteByRuleUserError
A user or client error that could occur during the execution of the entryPointDeleteByRule mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | EntryPointDeleteByRuleUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
EntryPointEdge
An edge in a connection.
| Field | Argument | Type | Description |
|---|---|---|---|
| cursor | String! | A cursor for use in pagination. | |
| node | EntryPoint | The item at the end of the edge. | |
EntryPointEventStatusUpdatePayload
Return type for the entryPointEventStatusUpdate mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| userErrors | [EntryPointEventStatusUpdateUserError!]! | List of errors that occured while executing the mutation. | |
EntryPointEventStatusUpdateUserError
A user or client error that could occur during the execution of the entryPointEventStatusUpdate mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | EntryPointEventStatusUpdateUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
EntryPointSetByOwnerPayload
Return type for the entryPointSetByOwner mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| entryPoint | EntryPoint | The entry point that was created or updated. | |
| userErrors | [EntryPointSetByOwnerUserError!]! | List of errors that occured while executing the mutation. | |
EntryPointSetByOwnerUserError
A user or client error that could occur during the execution of the entryPointSetByOwner mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | EntryPointSetByOwnerUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
EntryPointSetByRulePayload
Return type for the entryPointSetByRule mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| entryPoint | EntryPoint | The entry point that was created or updated. | |
| userErrors | [EntryPointSetByRuleUserError!]! | List of errors that occured while executing the mutation. | |
EntryPointSetByRuleUserError
A user or client error that could occur during the execution of the entryPointSetByRule mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | EntryPointSetByRuleUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
EntryPointVisibilityRuleValidity
Represents the validity of an entry point visibility rule.
| Field | Argument | Type | Description |
|---|---|---|---|
| status | EntryPointVisibilityRuleValidityStatus! | The validity status of the rule. | |
| userErrors | [EntryPointVisibilityRuleValidityUserError!]! | The errors that occurred when validating the rule. | |
EntryPointVisibilityRuleValidityUserError
An error that occurred when validating an entry point visibility rule.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | EntryPointVisibilityRuleValidityErrorCode! | The code of the error that occurred. | |
| field | [String!]! | The path to the field that the error occurred on. | |
| message | String! | The message describing the error. | |
EventCardV2EntryPoint
An Event Card entry point.
| Field | Argument | Type | Description |
|---|---|---|---|
| eventLiveAt | ISO8601DateTime | The start time of the event. | |
| eventStatus | String! | The status of the event. | |
| id | ID | The ID of the entry point. | |
| image | Image! | The image for the card when the event is active. | |
| location | EntryPointLocation | The location of the entry point. | |
| notificationTopic | String! | The topic to subscribe to for notifications. | |
| ownerId | ID | The ID of the owner of the entry point. Empty indicates the entry point has multiple owners set by the | |
| preActiveImage | Image! | The image for the card before the event is active. | |
| text | String | The text of the card. | |
| title | String! | The title of the card. | |
| updatedAt | ISO8601DateTime! | The date and time when the entry point was updated. | |
| visibilityRule | String | The visibility rule of the entry point. Empty indicates the entry point has a single owner set by the | |
ExternalVideo
Represents a video hosted outside of Shopify.
| Field | Argument | Type | Description |
|---|---|---|---|
| alt | String | The alt text for the media. | |
| embedUrl | URL! | The embed URL of the video for the respective host. | |
| previewImage | Image | The preview image for the media. | |
Image
The image for the entry point.
| Field | Argument | Type | Description |
|---|---|---|---|
| url | URL! | URL of the image. | |
ImageCollectionEntryPoint
This is a Mini Image Collection entry point.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | The ID of the entry point. | |
| items | [ImageCollectionEntryPointItem!]! | The items for the entry point. | |
| layout | ImageCollectionEntryPointLayout! | The layout for the entry point. | |
| location | EntryPointLocation | The location of the entry point. | |
| ownerId | ID | The ID of the owner of the entry point. Empty indicates the entry point has multiple owners set by the | |
| updatedAt | ISO8601DateTime! | The date and time when the entry point was updated. | |
| visibilityRule | String | The visibility rule of the entry point. Empty indicates the entry point has a single owner set by the | |
ImageCollectionEntryPointItem
This is a Mini image collection entry point item.
| Field | Argument | Type | Description |
|---|---|---|---|
| externalId | ID | The external ID for the item. Provided by the partner and opaque to the Shop app. | |
| image | Image! | The image for the item. | |
ImageCollectionV2EntryPoint
This is a Mini Image Collection V2 entry point.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | The ID of the entry point. | |
| items | [ImageCollectionV2EntryPointItem!]! | The items for the entry point. | |
| layout | ImageCollectionEntryPointLayout! | The layout for the entry point. | |
| location | EntryPointLocation | The location of the entry point. | |
| ownerId | ID | The ID of the owner of the entry point. Empty indicates the entry point has multiple owners set by the | |
| updatedAt | ISO8601DateTime! | The date and time when the entry point was updated. | |
| visibilityRule | String | The visibility rule of the entry point. Empty indicates the entry point has a single owner set by the | |
ImageCollectionV2EntryPointItem
This is a Mini image collection entry point item.
| Field | Argument | Type | Description |
|---|---|---|---|
| description | String | The description for ImageCollectionV2EntryPoint item. | |
| displayDate | ISO8601DateTime | The date when the ImageCollectionV2EntryPoint item was created. | |
| externalId | ID | The external ID for the item. Provided by the partner and opaque to the Shop app. | |
| image | Image! | The image for the item. | |
| relatedProducts | [ImageCollectionV2EntryPointItemRelatedProduct!]! | The list of products associated with this image. | |
ImageCollectionV2EntryPointItemRelatedProduct
The related product item shown on the image.
| Field | Argument | Type | Description |
|---|---|---|---|
| productId | ID! | The product ID for the entry point. | |
| productVariantId | ID | The product variant ID for the entry point. | |
InvitationAcceptPayload
Return type for the invitationAccept mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| token | String | The API key token that was created. | |
| userErrors | [InvitationAcceptUserError!]! | List of errors that occured while executing the mutation. | |
InvitationAcceptUserError
A user or client error that could occur during the execution of the invitationAccept mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | InvitationAcceptUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
LinkEntryPoint
A Link entry point to a Shop Mini.
| Field | Argument | Type | Description |
|---|---|---|---|
| actionText | String! | The call to action text of the link entry point. | |
| id | ID | The ID of the entry point. | |
| location | EntryPointLocation | The location of the entry point. | |
| ownerId | ID | The ID of the owner of the entry point. Empty indicates the entry point has multiple owners set by the | |
| updatedAt | ISO8601DateTime! | The date and time when the entry point was updated. | |
| visibilityRule | String | The visibility rule of the entry point. Empty indicates the entry point has a single owner set by the | |
Mini
Information about a Shop Mini.
| Field | Argument | Type | Description |
|---|---|---|---|
| developmentShopifyAppIds | [ID!]! | The development Shopify app IDs. | |
| handle | ID! | The mini handle. | |
| partnerName | String! | The partner name. | |
| productionShopifyAppId | ID! | The production Shopify app ID. | |
MiniTogglePayload
Return type for the miniToggle mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| enabled | Boolean | The flag whether the Mini is enabled or disabled. | |
MoneyV2
A money object capturing an amount and its currency.
| Field | Argument | Type | Description |
|---|---|---|---|
| amount | Decimal! | The decimal amount. | |
| approximateConvertedAmount ⚠️ | Decimal | Approximate conversion of price to currencyCodeConvertedTo. ⚠️ DEPRECATED
| |
| currencyCode | String! | The currency code. | |
| currencyCodeConvertedTo ⚠️ | String | Currency code that price was converted to. ⚠️ DEPRECATED
| |
NotificationTriggerPayload
Return type for the notificationTrigger mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| userErrors | [NotificationTriggerUserError!]! | List of errors that occured while executing the mutation. | |
| warnings | [Warning!] | The warnings related to the notification trigger. | |
NotificationTriggerUserError
A user or client error that could occur during the execution of the notificationTrigger mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | NotificationTriggerUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
PageInfo
Information about pagination in a connection.
| Field | Argument | Type | Description |
|---|---|---|---|
| endCursor | String | When paginating forwards, the cursor to continue. | |
| hasNextPage | Boolean! | When paginating forwards, are there more items? | |
| hasPreviousPage | Boolean! | When paginating backwards, are there more items? | |
| startCursor | String | When paginating backwards, the cursor to continue. | |
ProductEligibility
Represents the eligibility of a product within Shop.
| Field | Argument | Type | Description |
|---|---|---|---|
| productId | ID! | The ID of the product. | |
| status | ProductEligibilityStatus! | The eligibility status of the product. | |
ProductOfferCardEntryPoint
An Product Offer Card entry point.
| Field | Argument | Type | Description |
|---|---|---|---|
| discountedPrice | MoneyV2! | The discounted price of the offered product. | |
| expiresAt | ISO8601DateTime | The product offer expiration time. | |
| id | ID | The ID of the entry point. | |
| image | Image | The image for the offered product. | |
| location | EntryPointLocation | The location of the entry point. | |
| originalPrice | MoneyV2! | The original price of the offered product. | |
| ownerId | ID | The ID of the owner of the entry point. Empty indicates the entry point has multiple owners set by the | |
| productId | ID! | The product ID of the offered product on the card. | |
| title | String | The title of the offered product. | |
| updatedAt | ISO8601DateTime! | The date and time when the entry point was updated. | |
| variantId | ID | The variant ID of the offered product's variant on the card. | |
| visibilityRule | String | The visibility rule of the entry point. Empty indicates the entry point has a single owner set by the | |
ShopEligibility
Represents the eligibility of a shop within Shop.
| Field | Argument | Type | Description |
|---|---|---|---|
| shopDomain | String | The domain of the shop. | |
| shopId ⚠️ | ID | The ID of the shop. ⚠️ DEPRECATED
| |
| status | ShopEligibilityStatus! | The eligibility status of the shop. | |
StagedUpload
A staged upload where the file can be uploaded to and an id to identify it.
| Field | Argument | Type | Description |
|---|---|---|---|
| headers | String! | The headers to send with the upload request. | |
| id | ID! | The ID of the staged upload. | |
| url | URL! | The URL to upload the file to. | |
Submission
A submission for a Shop Mini.
| Field | Argument | Type | Description |
|---|---|---|---|
| description | String! | A description of the Shop Mini and any changes since the last released version. | |
| reference | String! | The unique reference for the submission. | |
| status | SubmissionStatus! | The status of the submission. | |
| submittedAt | ISO8601DateTime! | The date and time the submission was submitted. | |
SubmissionCancelPayload
Return type for the submissionCancel mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| submission | Submission | The cancelled submission. | |
| userErrors | [SubmissionCancelUserError!]! | List of errors that occured while executing the mutation. | |
SubmissionCancelUserError
A user or client error that could occur during the execution of the submissionCancel mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | SubmissionCancelUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
SubmissionConnection
The connection type for Submission.
| Field | Argument | Type | Description |
|---|---|---|---|
| edges | [SubmissionEdge!]! | A list of edges. | |
| nodes | [Submission!]! | A list of nodes. | |
| pageInfo | PageInfo! | Information to aid in pagination. | |
SubmissionCreatePayload
Return type for the submissionCreate mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| submission | Submission | The submission that was created. | |
| userErrors | [SubmissionCreateUserError!]! | List of errors that occured while executing the mutation. | |
SubmissionCreateUserError
A user or client error that could occur during the execution of the submissionCreate mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | SubmissionCreateUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
SubmissionEdge
An edge in a connection.
| Field | Argument | Type | Description |
|---|---|---|---|
| cursor | String! | A cursor for use in pagination. | |
| node | Submission | The item at the end of the edge. | |
SubmissionUploadCreatePayload
Return type for the submissionUploadCreate mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| upload | StagedUpload | The staged upload that was created. | |
| userErrors | [SubmissionUploadCreateUserError!]! | List of errors that occured while executing the mutation. | |
SubmissionUploadCreateUserError
A user or client error that could occur during the execution of the submissionUploadCreate mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | SubmissionUploadCreateUserErrorCode! | Error code associated with the error. | |
| field | [String!] | Which input value this error came from. | |
| message | String! | A description of the error. | |
VideoCollectionEntryPoint
This is a Mini video collection entry point.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | The ID of the entry point. | |
| items | [VideoCollectionEntryPointItem!]! | The items for the entry point. | |
| location | EntryPointLocation | The location of the entry point. | |
| ownerId | ID | The ID of the owner of the entry point. Empty indicates the entry point has multiple owners set by the | |
| updatedAt | ISO8601DateTime! | The date and time when the entry point was updated. | |
| visibilityRule | String | The visibility rule of the entry point. Empty indicates the entry point has a single owner set by the | |
VideoCollectionEntryPointItem
This is a Mini video collection entry point item.
| Field | Argument | Type | Description |
|---|---|---|---|
| contentCreator ⚠️ | ContentCreator | The content creator for the item. ⚠️ DEPRECATED
| |
| externalId | ID | The external ID for the item. Provided by the partner and opaque to the Shop app. | |
| fallbackImage | Image! | The fallback image for the item. | |
| productId | ID | The product ID for the item. | |
| video | ExternalVideo | The video for the item. | |
VideoCollectionV2EntryPoint
This is a Mini video collection V2 entry point.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | The ID of the entry point. | |
| items | [VideoCollectionV2EntryPointItem!]! | The items for the entry point. | |
| location | EntryPointLocation | The location of the entry point. | |
| ownerId | ID | The ID of the owner of the entry point. Empty indicates the entry point has multiple owners set by the | |
| updatedAt | ISO8601DateTime! | The date and time when the entry point was updated. | |
| visibilityRule | String | The visibility rule of the entry point. Empty indicates the entry point has a single owner set by the | |
VideoCollectionV2EntryPointContentCreator
This is a content creator that may appear next to a Mini entry point.
| Field | Argument | Type | Description |
|---|---|---|---|
| avatar | Image | The avatar of the content creator. | |
| name | String! | The name of the content creator. | |
VideoCollectionV2EntryPointItem
This is a Mini video collection entry point item.
| Field | Argument | Type | Description |
|---|---|---|---|
| contentCreator ⚠️ | VideoCollectionV2EntryPointContentCreator | The content creator for the item. ⚠️ DEPRECATED
| |
| externalId | ID! | The external ID for the item. Provided by the partner and opaque to the Shop app. | |
| fallbackImage | Image! | The fallback image for the item. | |
| previewVideo | ExternalVideo | The preview video to be used in the entry point. | |
| relatedProducts | [VideoCollectionV2EntryPointRelatedProduct!]! | The list of products associated with this video. | |
| video | ExternalVideo | The video for the item. | |
VideoCollectionV2EntryPointRelatedProduct
The related product item shown on the video.
| Field | Argument | Type | Description |
|---|---|---|---|
| productId | ID! | The product ID for the entry point. | |
| productVariantId | ID | The product variant ID for the entry point. | |
Warning
Informs API user about non critical casualties during the execution of a query or a mutation.
| Field | Argument | Type | Description |
|---|---|---|---|
| code | String! | Text identifier of the warning. | |
| message | String! | Description of the warning. | |
Inputs
ContentCreatorInput
Content creator that may appear next to a Mini entry point.
| Field | Type | Description | |
|---|---|---|---|
| name | String! | The name of the content creator. | |
| avatar | ImageInput | The avatar of the content creator. | |
DefaultCardEntryPointSetInput
The information needed to create a new default card entry point.
| Field | Type | Description | |
|---|---|---|---|
| title | String! | The title of the entry point. | |
| text | String | The text of the entry point. | |
| image | ImageInput | The image for the entry point. | |
| actionText | String | The action text of the entry point. | |
EntryPointSetInput
The information needed to create a new entry point.
| Field | Type | Description | |
|---|---|---|---|
| link | LinkEntryPointSetInput | The link entry point set input. | |
| defaultCard | DefaultCardEntryPointSetInput | The default card entry point set input. | |
| imageCollection | ImageCollectionEntryPointSetInput | The image collection entry point set input. | |
| imageCollectionV2 | ImageCollectionV2EntryPointSetInput | The image collection v2 entry point set input. | |
| videoCollection | VideoCollectionEntryPointSetInput | The video collection entry point set input. | |
| videoCollectionV2 | VideoCollectionV2EntryPointSetInput | The video collection entry point V2 set input. | |
| eventCardV2 | EventCardV2EntryPointSetInput | The event card entry point set input. | |
| productOfferCard | ProductOfferCardEntryPointSetInput | The product offer card entry point set input. | |
EventCardV2EntryPointSetInput
The information needed to create a new event card entry point.
| Field | Type | Description | |
|---|---|---|---|
| title | String! | The title for the event card entry point. | |
| text | String | The text for the event card entry point. | |
| preActiveImage | ImageInput! | The image for the event card entry point before the event is active. | |
| image | ImageInput! | The image for the event card entry point when the event is active. | |
| eventStatus | EventCardV2EntryPointEventStatus! | The event status for the event card entry point. | |
| eventLiveAt | ISO8601DateTime | The event start time for the event card entry point. | |
| notificationTopic | String! | The notification topic for the event card entry point. | |
ExternalVideoInput
Represents a video hosted outside of Shopify.
| Field | Type | Description | |
|---|---|---|---|
| alt | String | A word or phrase to share the nature or contents of a media. | |
| previewImage | ImageInput | The preview image for the media. | |
| embedUrl | URL! | The embed URL of the video for the respective host. | |
ImageCollectionEntryPointItemInput
This is a Mini Image Collection entry point item.
| Field | Type | Description | |
|---|---|---|---|
| image | ImageInput! | The image for the item. | |
| externalId | String | The external ID for the item. Provided by the partner and opaque to the Shop app. | |
ImageCollectionEntryPointSetInput
The information needed to create a new image collection entry point.
| Field | Type | Description | |
|---|---|---|---|
| items | [ImageCollectionEntryPointItemInput!]! | The items for the entry point. It can't be empty. | |
ImageCollectionV2EntryPointItemInput
This is a Mini Image Collection entry point item.
| Field | Type | Description | |
|---|---|---|---|
| image | ImageInput! | The image for the item. | |
| externalId | String! | The external ID for the item. Provided by the partner and opaque to the Shop app. | |
| relatedProducts | [ImageCollectionV2EntryPointItemRelatedProductInput!]! | The list of products associated with this image. | |
| description | String | The description for the ImageCollectionV2EntryPoint item. | |
| displayDate | ISO8601DateTime | The date when the ImageCollectionV2EntryPoint item will be displayed. | |
ImageCollectionV2EntryPointItemRelatedProductInput
This is a related product for the image.
| Field | Type | Description | |
|---|---|---|---|
| productId | String! | The product ID for the entry point. | |
| productVariantId | String | The product variant ID for the entry point. | |
ImageCollectionV2EntryPointSetInput
The information needed to create a new image collection entry point.
| Field | Type | Description | |
|---|---|---|---|
| items | [ImageCollectionV2EntryPointItemInput!]! | The items for the entry point. It can't be empty. | |
ImageInput
The information needed to create a new image.
| Field | Type | Description | |
|---|---|---|---|
| url | URL! | The URL of the Shopify hosted image. | |
LinkEntryPointSetInput
The information needed to create a new link entry point.
| Field | Type | Description | |
|---|---|---|---|
| actionText | String! | The call to action text of the link entry point. | |
MoneyInput
The information needed to create a new money.
| Field | Type | Description | |
|---|---|---|---|
| amount | Decimal! | Decimal money amount. | |
| currencyCode | CurrencyCode! | Currency code of the money. | |
ProductOfferCardEntryPointSetInput
The information needed to create a new product offer card entry point.
| Field | Type | Description | |
|---|---|---|---|
| productId | ID! | The product ID for the product offer card entry point. | |
| originalPrice | MoneyInput! | The text for the product offer card entry point. | |
| discountedPrice | MoneyInput! | The text for the product offer card entry point. | |
| title | String | The title for the product offer card entry point. | |
| image | ImageInput | The image for the product offer card entry point. | |
| expiresAt | ISO8601DateTime | The event start time for the product offer card entry point. | |
| variantId | ID | The variant ID for the product offer card entry point. | |
StagedUploadInput
The information needed to create a new staged upload.
| Field | Type | Description | |
|---|---|---|---|
| filename | String! | The name of the file. | |
| fileSize | Int! | The size of the file in bytes. | |
| checksum | String! | The base64-encoded md5 hash of the file contents. | |
| mimeType | String! | The MIME of the file. | |
TimeRangeFilter
This filter selects objects that were updated within a specified time range.
| Field | Type | Description | |
|---|---|---|---|
| min | ISO8601DateTime | The minimum updated at date and time in the range. | |
| max | ISO8601DateTime | The maximum updated at date and time in the range. | |
VideoCollectionEntryPointItemInput
This is a Mini Video Collection entry point item.
| Field | Type | Description | |
|---|---|---|---|
| video | ExternalVideoInput! | The video for the entry point. | |
| fallbackImage | ImageInput! | The fallback image for the entry point. | |
| externalId | String | The external ID for the item. Provided by the partner and opaque to the Shop app. | |
| productId | ID | The product ID for the entry point. | |
| productVariantId | ID | The product variant ID for the entry point. | |
VideoCollectionEntryPointSetInput
The information needed to create or update a video collection entry point.
| Field | Type | Description | |
|---|---|---|---|
| items | [VideoCollectionEntryPointItemInput!]! | The items for the entry point. It can't be empty. | |
VideoCollectionV2EntryPointItemInput
This is a Mini Video Collection V2 entry point item.
| Field | Type | Description | |
|---|---|---|---|
| video | ExternalVideoInput! | The video for the entry point. | |
| relatedProducts | [VideoCollectionV2EntryPointItemRelatedProductInput!]! | The list of products associated with this video. | |
| fallbackImage | ImageInput! | The fallback image for the entry point. | |
| externalId | String! | The external ID for the item. Provided by the partner and opaque to the Shop app. | |
| previewVideo | ExternalVideoInput | The video to be shown in the entry point. Should be shorter and limited to the most important part. | |
VideoCollectionV2EntryPointItemRelatedProductInput
This is a related product for the video.
| Field | Type | Description | |
|---|---|---|---|
| productId | ID! | The product ID for the entry point. | |
| productVariantId | ID | The product variant ID for the entry point. | |
VideoCollectionV2EntryPointSetInput
The information needed to create or update a video collection V2 entry point.
| Field | Type | Description | |
|---|---|---|---|
| items | [VideoCollectionV2EntryPointItemInput!]! | The items for the entry point. It can't be empty. | |
Enums
CurrencyCode
ISO currency code.
| Value | Description |
|---|---|
| CYP | Cypriot pound. |
| EEK | Estonian Kroon. |
| GHC | Ghanaian Cedi. |
| MRO | Mauritanian Ouguiya. |
| MTL | Maltese Lira. |
| STD | São Tomé and Príncipe Dobra. |
| TMM | Turkmenistani Manat. |
| VEB | Venezuelan Bolívar. |
| VEF | Venezuelan Bolívar fuerte. |
| ZWD | Zimbabwean Dollar. |
| ZWL | Zimbabwean Dollar. |
| ZWN | Zimbabwean Dollar. |
| ZWR | Zimbabwean Dollar. |
| JEP | Jersey Pound. |
| KID | Kiribati Dollar. |
| GGP | Guernsey Pound. |
| IMP | Isle of Man Pound. |
| XFU | UIC Franc. |
| GBX | British Penny. |
| AED | United Arab Emirates Dirham. |
| AFN | Afghan Afghani. |
| ALL | Albanian Lek. |
| AMD | Armenian Dram. |
| ANG | Netherlands Antillean Gulden. |
| AOA | Angolan Kwanza. |
| ARS | Argentine Peso. |
| AUD | Australian Dollar. |
| AWG | Aruban Florin. |
| AZN | Azerbaijani Manat. |
| BAM | Bosnia and Herzegovina Convertible Mark. |
| BBD | Barbadian Dollar. |
| BDT | Bangladeshi Taka. |
| BGN | Bulgarian Lev. |
| BHD | Bahraini Dinar. |
| BIF | Burundian Franc. |
| BMD | Bermudian Dollar. |
| BND | Brunei Dollar. |
| BOB | Bolivian Boliviano. |
| BRL | Brazilian Real. |
| BSD | Bahamian Dollar. |
| BTN | Bhutanese Ngultrum. |
| BWP | Botswana Pula. |
| BYN | Belarusian Ruble. |
| BYR | Belarusian Ruble. |
| BZD | Belize Dollar. |
| CAD | Canadian Dollar. |
| CDF | Congolese Franc. |
| CHF | Swiss Franc. |
| CLF | Unidad de Fomento. |
| CLP | Chilean Peso. |
| CNY | Chinese Renminbi Yuan. |
| COP | Colombian Peso. |
| CRC | Costa Rican Colón. |
| CUC | Cuban Convertible Peso. |
| CUP | Cuban Peso. |
| CVE | Cape Verdean Escudo. |
| CZK | Czech Koruna. |
| DJF | Djiboutian Franc. |
| DKK | Danish Krone. |
| DOP | Dominican Peso. |
| DZD | Algerian Dinar. |
| EGP | Egyptian Pound. |
| ERN | Eritrean Nakfa. |
| ETB | Ethiopian Birr. |
| EUR | Euro. |
| FJD | Fijian Dollar. |
| FKP | Falkland Pound. |
| GBP | British Pound. |
| GEL | Georgian Lari. |
| GHS | Ghanaian Cedi. |
| GIP | Gibraltar Pound. |
| GMD | Gambian Dalasi. |
| GNF | Guinean Franc. |
| GTQ | Guatemalan Quetzal. |
| GYD | Guyanese Dollar. |
| HKD | Hong Kong Dollar. |
| HNL | Honduran Lempira. |
| HRK | Croatian Kuna. |
| HTG | Haitian Gourde. |
| HUF | Hungarian Forint. |
| IDR | Indonesian Rupiah. |
| ILS | Israeli New Sheqel. |
| INR | Indian Rupee. |
| IQD | Iraqi Dinar. |
| IRR | Iranian Rial. |
| ISK | Icelandic Króna. |
| JMD | Jamaican Dollar. |
| JOD | Jordanian Dinar. |
| JPY | Japanese Yen. |
| KES | Kenyan Shilling. |
| KGS | Kyrgyzstani Som. |
| KHR | Cambodian Riel. |
| KMF | Comorian Franc. |
| KPW | North Korean Won. |
| KRW | South Korean Won. |
| KWD | Kuwaiti Dinar. |
| KYD | Cayman Islands Dollar. |
| KZT | Kazakhstani Tenge. |
| LAK | Lao Kip. |
| LBP | Lebanese Pound. |
| LKR | Sri Lankan Rupee. |
| LRD | Liberian Dollar. |
| LSL | Lesotho Loti. |
| LTL | Lithuanian Litas. |
| LVL | Latvian Lats. |
| LYD | Libyan Dinar. |
| MAD | Moroccan Dirham. |
| MDL | Moldovan Leu. |
| MGA | Malagasy Ariary. |
| MKD | Macedonian Denar. |
| MMK | Myanmar Kyat. |
| MNT | Mongolian Tögrög. |
| MOP | Macanese Pataca. |
| MRU | Mauritanian New Ouguiya. |
| MUR | Mauritian Rupee. |
| MVR | Maldivian Rufiyaa. |
| MWK | Malawian Kwacha. |
| MXN | Mexican Peso. |
| MYR | Malaysian Ringgit. |
| MZN | Mozambican Metical. |
| NAD | Namibian Dollar. |
| NGN | Nigerian Naira. |
| NIO | Nicaraguan Córdoba. |
| NOK | Norwegian Krone. |
| NPR | Nepalese Rupee. |
| NZD | New Zealand Dollar. |
| OMR | Omani Rial. |
| PAB | Panamanian Balboa. |
| PEN | Peruvian Sol. |
| PGK | Papua New Guinean Kina. |
| PHP | Philippine Peso. |
| PKR | Pakistani Rupee. |
| PLN | Polish Złoty. |
| PYG | Paraguayan Guaraní. |
| QAR | Qatari Riyal. |
| RON | Romanian Leu. |
| RSD | Serbian Dinar. |
| RUB | Russian Ruble. |
| RWF | Rwandan Franc. |
| SAR | Saudi Riyal. |
| SBD | Solomon Islands Dollar. |
| SCR | Seychellois Rupee. |
| SDG | Sudanese Pound. |
| SEK | Swedish Krona. |
| SGD | Singapore Dollar. |
| SHP | Saint Helenian Pound. |
| SKK | Slovak Koruna. |
| SLL | Sierra Leonean Leone. |
| SOS | Somali Shilling. |
| SRD | Surinamese Dollar. |
| SSP | South Sudanese Pound. |
| STN | São Tomé and Príncipe Dobra. |
| SVC | Salvadoran Colón. |
| SYP | Syrian Pound. |
| SZL | Swazi Lilangeni. |
| THB | Thai Baht. |
| TJS | Tajikistani Somoni. |
| TMT | Turkmenistani Manat. |
| TND | Tunisian Dinar. |
| TOP | Tongan Paʻanga. |
| TRY | Turkish Lira. |
| TTD | Trinidad and Tobago Dollar. |
| TWD | New Taiwan Dollar. |
| TZS | Tanzanian Shilling. |
| UAH | Ukrainian Hryvnia. |
| UGX | Ugandan Shilling. |
| USD | United States Dollar. |
| UYU | Uruguayan Peso. |
| UZS | Uzbekistan Som. |
| VED | Venezuelan Bolívar soberano. |
| VES | Venezuelan Bolívar soberano. |
| VND | Vietnamese Đồng. |
| VUV | Vanuatu Vatu. |
| WST | Samoan Tala. |
| XAF | Central African Cfa Franc. |
| XAG | Silver (Troy Ounce). |
| XAU | Gold (Troy Ounce). |
| XBA | European Composite Unit. |
| XBB | European Monetary Unit. |
| XBC | European Unit of Account 9. |
| XBD | European Unit of Account 17. |
| XCD | East Caribbean Dollar. |
| XDR | Special Drawing Rights. |
| XOF | West African Cfa Franc. |
| XPD | Palladium. |
| XPF | Cfp Franc. |
| XPT | Platinum. |
| XTS | Codes specifically reserved for testing purposes. |
| YER | Yemeni Rial. |
| ZAR | South African Rand. |
| ZMK | Zambian Kwacha. |
| ZMW | Zambian Kwacha. |
EntryPointDeleteAllUserErrorCode
Possible error codes that can be returned by EntryPointDeleteAllUserError.
| Value | Description |
|---|---|
| SHOP_NOT_FOUND | Error code when the shop is not found. |
EntryPointDeleteByOwnerUserErrorCode
Possible error codes that can be returned by EntryPointDeleteByOwnerUserError.
| Value | Description |
|---|---|
| DEFINITION_NOT_FOUND | Error code when the entry point definition is not found from the manifest. |
| ENTRY_POINT_NOT_FOUND | Error code when the entry point to be deleted is not found. |
EntryPointDeleteByRuleUserErrorCode
Possible error codes that can be returned by EntryPointDeleteByRuleUserError.
| Value | Description |
|---|---|
| SHOP_NOT_FOUND | Error code when the shop is not found. |
| DEFINITION_NOT_FOUND | Error code when the entry point definition is not found from the manifest. |
| ENTRY_POINT_NOT_FOUND | Error code when the entry point to be deleted is not found. |
EntryPointEventStatus
The event status enum for an entry point.
| Value | Description |
|---|---|
| PRE_ACTIVE | The pre active status for Mini entry point event type. |
| ACTIVE | The active status for Mini entry point event type. |
| POST_ACTIVE | The post active status for Mini entry point event type. |
EntryPointEventStatusUpdateUserErrorCode
Possible error codes that can be returned by EntryPointEventStatusUpdateUserError.
| Value | Description |
|---|---|
| SHOP_NOT_FOUND | Error code when the shop is not found. |
| PRODUCT_NOT_FOUND | Error code when the product is not found. |
EntryPointLocation
The entry point location of a Mini.
| Value | Description |
|---|---|
| PRODUCT_PAGE | The Mini should be displayed on the product page. |
| STORE_PAGE | The Mini should be displayed on the store page. |
| PRODUCT_PAGE_CONTEXT_MENU | The Mini should be displayed on the product details page context menu. |
| STORE_PAGE_CONTEXT_MENU | The Mini should be displayed on the store page context menu. |
| ORDER_CONFIRMATION_PAGE | The Mini should be displayed on the order confirmation page. |
| ORDER_MANAGEMENT_PAGE | The Mini should be displayed on the order management page. |
| HOME_FEED | The Mini should be displayed on the home feed. |
EntryPointSetByOwnerUserErrorCode
Possible error codes that can be returned by EntryPointSetByOwnerUserError.
| Value | Description |
|---|---|
| SHOP_NOT_FOUND | Error code when the shop is not found. |
| SHOP_DOMAIN_NOT_PROVIDED | Error code when the shop domain argument is not provided. |
| SHOP_NOT_ELIGIBLE | Error code when the shop is not eligible for Shop Minis. |
| SHOPIFY_APP_NOT_INSTALLED | Error code when the shop does not have any Shopify App installed for the associated Shop Mini. |
| PRODUCT_NOT_ELIGIBLE | Error code when the product is not eligible for Shop Minis. |
| DEFINITION_NOT_FOUND | Error code when the entry point definition is not found from the manifest. |
| UNEXPECTED_OWNER_ID | Error code when the entry point owner is not the expected type for the given entry point location. |
| NO_VALID_ITEMS | Error code when all entry point items are invalid. |
EntryPointSetByRuleUserErrorCode
Possible error codes that can be returned by EntryPointSetByRuleUserError.
| Value | Description |
|---|---|
| SHOP_NOT_FOUND | The shop is not found. |
| SHOP_DOMAIN_NOT_PROVIDED | Error code when the shop domain argument is not provided. |
| SHOP_NOT_ELIGIBLE | The shop is not eligible for Shop Minis. |
| SHOPIFY_APP_NOT_INSTALLED | Error code when the shop does not have any Shopify App installed for the associated Shop Mini. |
| DEFINITION_NOT_FOUND | The entry point definition is not found from the manifest. |
| INVALID_VISIBILITY_RULE | The visibility rule is invalid. |
EntryPointType
The entry point type of a Mini.
| Value | Description |
|---|---|
| ACTION_BUTTON | The Mini should be displayed as an action button. |
| CONTENT_CARD | The Mini should be displayed as a card with content. |
| EVENT_CARD | The Mini should be displayed as a card with a reminder button. |
| LINK | The Mini should be displayed as a link. |
| PRODUCT_OFFER_CARD | The Mini should be displayed as a product offer card. |
| DEFAULT_CARD | The Mini should be displayed as a card with content. |
| EVENT_CARD_V2 | The Mini should be displayed as a card with a reminder button. |
| IMAGE_COLLECTION | The Mini should be displayed as a collection of images. |
| IMAGE_COLLECTION_V2 | The Mini should be displayed as a collection of images with related products. |
| VIDEO_COLLECTION | The Mini should be displayed as a collection of videos. |
| VIDEO_COLLECTION_V2 | The Mini should be displayed as a collection of videos. |
EntryPointVisibilityRuleValidityErrorCode
The error code for an entry point visibility rule error.
| Value | Description |
|---|---|
| INCORRECT_SYNTAX | Rule is not parseable. Please refer to https://shopify.dev/api/usage/search-syntax for more information. |
| UNSUPPORTED_FIELDS | Unsupported fields given. Please refer to https://github.com/Shopify/shop-minis/blob/main/docs/ENTRY_POINT_VISIBILITY_RULE_FOR_PRODUCT_DETAILS_PAGES.md for more information. |
| FIELDS_UNSPECIFIED | Rules cannot be applied to all fields. Please specify the field name. |
| INCOMPATIBLE_COMPARATORS | Incompatible comparator found for the given fields. |
| INCOMPATIBLE_QUERY_TYPES | Incompatible values given to the fields. Please refer to https://shopify.dev/api/usage/search-syntax for more information. |
| MAXIMUM_LENGTH_EXCEEDED | Rule is too long. Please refer to https://shopify.dev/api/usage/search-syntax for more information. |
EntryPointVisibilityRuleValidityStatus
The validity status of an entry point visibility rule.
| Value | Description |
|---|---|
| VALID | The rule is valid. |
| INVALID | The rule is not valid. |
EventCardV2EntryPointEventStatus
The event status of the Mini event card entry point.
| Value | Description |
|---|---|
| PRE_ACTIVE | The pre active status for Mini entry point event type. |
| ACTIVE | The active status for Mini entry point event type. |
| POST_ACTIVE | The post active status for Mini entry point event type. |
ImageCollectionEntryPointLayout
The layout of the Mini Image Collection entry point.
| Value | Description |
|---|---|
| GRID | The layout is a grid. |
| CAROUSEL | The layout is a carousel. |
InvitationAcceptUserErrorCode
Possible error codes that can be returned by InvitationAcceptUserError.
| Value | Description |
|---|---|
| INVITATION_NOT_FOUND | Error code when the invitation is not found. |
NotificationTriggerUserErrorCode
Possible error codes that can be returned by NotificationTriggerUserError.
| Value | Description |
|---|---|
| SCOPED_ENTITY_NOT_FOUND | Error code when the scoped entity is not found. |
| TEMPLATE_NOT_FOUND | Error code when the template handle is not found in the Mini's manifest. |
| TOPIC_NOT_FOUND | Error code when the template's topic_handle is invalid. |
| TOPIC_SCOPE_NOT_MATCHING_ENTITY | Error code when scopedEntityId object does not match topic scope. |
| SHOP_NOT_FOUND | Error code when the shop is not found. |
ProductEligibilityStatus
The eligibility status of a product.
| Value | Description |
|---|---|
| ELIGIBLE | The product is eligible to appear in Shop. |
| INELIGIBLE | The product is ineligible to appear in Shop. |
ShopEligibilityStatus
The eligibility status of a shop.
| Value | Description |
|---|---|
| ELIGIBLE | The shop is eligible to appear in Shop. |
| INELIGIBLE | The shop is ineligible to appear in Shop. |
SubmissionCancelUserErrorCode
Possible error codes that can be returned by SubmissionCancelUserError.
| Value | Description |
|---|---|
| NOT_PENDING | Error code when the submission does not have a pending status. |
| NOT_FOUND | Error code when the submission is not found. |
SubmissionCreateUserErrorCode
Possible error codes that can be returned by SubmissionCreateUserError.
| Value | Description |
|---|---|
| ALREADY_PENDING_SUBMISSION | Error code when there is already a pending submission. |
| UPLOAD_NOT_FOUND | Error code when the upload ID is not valid. Either it is does not point to a blob or is not signed correctly. |
| FILE_NOT_FOUND | Error code when the file does not exist in the storage service. |
SubmissionStatus
The status of a submission.
| Value | Description |
|---|---|
| PENDING | The submission is pending review. |
| APPROVED | The submission has been approved. |
| REJECTED | The submission has been rejected. |
| CANCELLED | The submission has been cancelled. |
SubmissionUploadCreateUserErrorCode
Possible error codes that can be returned by SubmissionUploadCreateUserError.
| Value | Description |
|---|---|
| INVALID_MIME_TYPE | Error code when an invalid MIME type is provided. |
| INVALID_CHECKSUM | Error code when an invalid checksum is provided. |
| INVALID_FILE_SIZE | Error code when the file size is less than 0 or exceeds 1048576 bytes. |
Scalars
Boolean
Represents true or false values.
Decimal
A signed decimal number serialized as a string. Example value: "29.99".
ID
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
ISO8601DateTime
An ISO 8601-encoded datetime
Int
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
String
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
URL
Represents an RFC 3986 and RFC 3987-compliant URI string.
For example, "https://johns-apparel.myshopify.com" is a valid URL. It includes a scheme (https) and a host (johns-apparel.myshopify.com).
Interfaces
EntryPoint
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | The ID of the entry point. | |
| location | EntryPointLocation | The location of the entry point. | |
| ownerId | ID | The ID of the owner of the entry point. Empty indicates the entry point has multiple owners set by the | |
| updatedAt | ISO8601DateTime! | The date and time when the entry point was updated. | |
| visibilityRule | String | The visibility rule of the entry point. Empty indicates the entry point has a single owner set by the | |