Skip to main content

shopify Component

interact with the Shopify Access Service portion of the Shopify API

Component key: shopify

Description#

The Shopify Access component interacts with the Access Service portion of the Shopify API.

Authorization Methods#

shopify requires one of the following authorization methods:

Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Password |  password

Username |  username

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Authorization URL |  auth_uri

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Access Token URL |  token_uri

The username and password refer to the Shopify client id, and password used in the Shopify Basic Auth setup found here: \https://shopify.dev/concepts/about-apis/authentication

Actions#

Adjust Inventory Levels#

Adjusts the inventory level of an inventory item at a single location https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#adjust-2020-10 | key: createInventoryLevelsAdjust

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

AvailableAdjustmentRequired

data
availableAdjustmentRequired

InventoryItemIdRequired

data
inventoryItemIdRequired

LocationIdRequired

data
locationIdRequired

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Connect Inventory Levels#

Connects an inventory item to a location by creating an inventory level at that location. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations. https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#connect-2020-10 | key: createInventoryLevelsConnect

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

InventoryItemIdRequired

data
inventoryItemIdRequired

LocationIdRequired

data
locationIdRequired

RelocateIfNecessary

data
relocateIfNecessary

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Count Customer Saved Searches#

Retrieves a count of all customer saved searches. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-10 | key: getCustomerSavedSearchesCount

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

SinceId

data
sinceId

Store Url

string
/ Required
storeUrl

Create Application Charge#

Creates an application charge https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-10 | key: createApplicationCharges

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Application Credit#

Creates an application credit https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-10 | key: createApplicationCredits

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Application Usage Charge#

Creates a usage charge https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2020-10 | key: createRecurringApplicationChargesParamRecurringApplicationChargeIdUsageCharges

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RecurringApplicationChargeId

string
recurringApplicationChargeId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Blog Articles#

Creates an article for a blog https://shopify.dev/docs/admin-api/rest/reference/online-store/article#create-2020-10 | key: createBlogsParamBlogIdArticles

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

BlogId

string
blogId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Customer#

Creates a customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#create-2020-10 | key: createCustomers

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Customer Account Activation Url#

Generate an account activation URL for a customer whose account is not yet enabled. This is useful when you've imported a large number of customers and want to send them activation emails all at once. Using this approach, you'll need to generate and send the activation emails yourself. The account activation URL generated by this endpoint is for one-time use and will expire after 30 days. If you make a new POST request to this endpoint, then a new URL will be generated. The new URL will be again valid for 30 days, but the previous URL will no longer be valid. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2020-10 | key: createCustomersParamCustomerIdAccountActivationUrl

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Customer Address#

Creates a new address for a customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2020-10 | key: createCustomersParamCustomerIdAddresses

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Customer Saved Search#

Creates a customer saved search. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2020-10 | key: createCustomerSavedSearches

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Discount Code#

Creates a discount code https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#create-2020-10 | key: createPriceRulesParamPriceRuleIdDiscountCodes

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

PriceRuleId

string
priceRuleId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Metafield#

Creates a new metafield for a resource. https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2020-10 | key: createMetafields

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Price Rules Batch#

Creates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include:

status: The state of the discount code creation job. Possible values are:

queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished.

codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses:

"Price rule target selection can't be blank" "Price rule allocation method can't be blank" https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-10 | key: createPriceRulesParamPriceRuleIdBatch

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

PriceRuleId

string
priceRuleId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Recurring Application Charges#

Creates a recurring application charge https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2020-10 | key: createRecurringApplicationCharges

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Redirect#

Creates a redirect. When you provide a full URL as the value of the path property, it will be saved as an absolute path without the domain. For example, "path": http://www.johns-apparel.com/springwear will be saved as "path": "springwear". https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2020-10 | key: createRedirects

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Report#

Creates a new report https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-2020-10 | key: createReports

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Name

data
name

RequestBody

data
requestBody

ShopifyQl

data
shopifyQl

Store Url

string
/ Required
storeUrl

Create Storefront Access Tokens#

Creates a new storefront access token https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2020-10 | key: createStorefrontAccessTokens

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Create Webhooks#

Create a new webhook subscription by specifying both an address and a topic https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-2020-10 | key: createWebhooks

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Format

data
format

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Delete Blog Article#

Deletes an article https://shopify.dev/docs/admin-api/rest/reference/online-store/article#destroy-2020-10 | key: deleteBlogsParamBlogIdArticlesParamArticleId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

ArticleId

string
articleId

BlogId

string
blogId

Store Url

string
/ Required
storeUrl

Delete Customer#

Deletes a customer. A customer can't be deleted if they have existing orders. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#destroy-2020-10 | key: deleteCustomersParamCustomerId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

Store Url

string
/ Required
storeUrl

Delete Customer Saved Search#

Deletes a customer saved search. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2020-10 | key: deleteCustomerSavedSearchesParamCustomerSavedSearchId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerSavedSearchId

string
customerSavedSearchId

Store Url

string
/ Required
storeUrl

Delete Customers Address#

Removes an address from a customer’s address list. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#destroy-2020-10 | key: deleteCustomersParamCustomerIdAddressesParamAddressId

InputKeyNotesExample

AddressId

string
addressId

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

Store Url

string
/ Required
storeUrl

Delete Discount Code#

Deletes a discount code https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#destroy-2020-10 | key: deletePriceRulesParamPriceRuleIdDiscountCodesParamDiscountCodeId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

DiscountCodeId

string
discountCodeId

PriceRuleId

string
priceRuleId

Store Url

string
/ Required
storeUrl

Delete Inventory Levels#

Deletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level. https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#destroy-2020-10 | key: deleteInventoryLevels

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

InventoryItemId

string
inventoryItemId

InventoryItemIdRequired

data
inventoryItemIdRequired

LocationIdRequired

data
locationIdRequired

LocationIds

data
locationIds

Store Url

string
/ Required
storeUrl

Delete Metafield#

Deletes a metafield by its ID. https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-10 | key: deleteMetafieldsParamMetafieldId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

MetafieldId

string
metafieldId

Store Url

string
/ Required
storeUrl

Delete Recurring Application Charge#

Cancels a recurring application charge https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2020-10 | key: deleteRecurringApplicationChargesParamRecurringApplicationChargeId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RecurringApplicationChargeId

string
recurringApplicationChargeId

Store Url

string
/ Required
storeUrl

Delete Report#

Deletes a report https://shopify.dev/docs/admin-api/rest/reference/analytics/report#destroy-2020-10 | key: deleteReportsParamReportId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

ReportId

string
reportId

Store Url

string
/ Required
storeUrl

Delete Storefront Access Token#

Deletes an existing storefront access token https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2020-10 | key: deleteStorefrontAccessTokensParamStorefrontAccessTokenId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

StorefrontAccessTokenId

string
storefrontAccessTokenId

Store Url

string
/ Required
storeUrl

Delete Theme#

Deletes a theme. https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#destroy-2020-10 | key: deleteThemesParamThemeId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Store Url

string
/ Required
storeUrl

ThemeId

string
themeId

Delete Theme Assets#

Deletes an asset from a theme. https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2020-10 | key: deleteThemesParamThemeIdAssets

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

AssetKey

string
assetKey

Store Url

string
/ Required
storeUrl

ThemeId

string
themeId

Delete Webhook#

Delete a webhook subscription https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-2020-10 | key: deleteWebhooksParamWebhookId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Store Url

string
/ Required
storeUrl

WebhookId

string
webhookId

Get Application Charge#

Retrieves an application charge https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-10 | key: getApplicationChargesParamApplicationChargeId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

ApplicationChargeId

string
applicationChargeId

Fields

data
fields

Store Url

string
/ Required
storeUrl

Get Application Credit#

Retrieves a single application credit https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-10 | key: getApplicationCreditsParamApplicationCreditId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

ApplicationCreditId

string
applicationCreditId

Fields

data
fields

Store Url

string
/ Required
storeUrl

Get Application Credits#

Retrieves all application credits https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-10 | key: getApplicationCredits

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

Store Url

string
/ Required
storeUrl

Get Application Usage Charge#

Retrieves a single charge https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#show-2020-10 | key: getRecurringApplicationChargesParamRecurringApplicationChargeIdUsageChargesParamUsageChargeId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

RecurringApplicationChargeId

string
recurringApplicationChargeId

Store Url

string
/ Required
storeUrl

UsageChargeId

string
usageChargeId

Get Blog Article#

Retrieves a single article https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2020-10 | key: getBlogsParamBlogIdArticlesParamArticleId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

ArticleId

string
articleId

BlogId

string
blogId

Fields

data
fields

Store Url

string
/ Required
storeUrl

Get Blog Articles Count#

Retrieves a count of all articles from a blog https://shopify.dev/docs/admin-api/rest/reference/online-store/article#count-2020-10 | key: getBlogsParamBlogIdArticlesCount

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

BlogId

string
blogId

CreatedAtMax

data
createdAtMax

CreatedAtMin

data
createdAtMin

PublishedAtMax

data
publishedAtMax

PublishedAtMin

data
publishedAtMin

PublishedStatus

data
publishedStatus

Store Url

string
/ Required
storeUrl

UpdatedAtMax

data
updatedAtMax

UpdatedAtMin

data
updatedAtMin

Get Customer#

Retrieves a single customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#show-2020-10 | key: getCustomersParamCustomerId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

Fields

data
fields

Store Url

string
/ Required
storeUrl

Get Customer Address#

Retrieves a single customer address. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2020-10 | key: getCustomersParamCustomerIdAddressesParamAddressId

InputKeyNotesExample

AddressId

string
addressId

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

Store Url

string
/ Required
storeUrl

Get Customer Saved Search#

Retrieves a single customer saved search. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2020-10 | key: getCustomerSavedSearchesParamCustomerSavedSearchId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerSavedSearchId

string
customerSavedSearchId

Fields

data
fields

Store Url

string
/ Required
storeUrl

Get Customers Count#

Retrieves a count of all customers. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2020-10 | key: getCustomersCount

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Store Url

string
/ Required
storeUrl

Get Discount Code#

Retrieves a single discount code https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2020-10 | key: getPriceRulesParamPriceRuleIdDiscountCodesParamDiscountCodeId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

DiscountCodeId

string
discountCodeId

PriceRuleId

string
priceRuleId

Store Url

string
/ Required
storeUrl

Get Discount Codes Lookup#

Retrieves the location of a discount code. The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically. https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#lookup-2020-10 | key: getDiscountCodesLookup

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Code

data
code

Store Url

string
/ Required
storeUrl

Get Event#

Retrieves a single event by its ID https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2020-10 | key: getEventsParamEventId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

EventId

string
eventId

Fields

data
fields

Store Url

string
/ Required
storeUrl

Get Events Count#

Retrieves a count of events https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2020-10 | key: getEventsCount

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CreatedAtMax

data
createdAtMax

CreatedAtMin

data
createdAtMin

Store Url

string
/ Required
storeUrl

Get Inventory Items#

Retrieves a single inventory item by ID https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-10 | key: getInventoryItemsParamInventoryItemId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

InventoryItemId

string
inventoryItemId

Store Url

string
/ Required
storeUrl

Get Locations#

Retrieves a single location by its ID https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-10 | key: getLocationsParamLocationId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

LocationIds

data
locationIds

Store Url

string
/ Required
storeUrl

Get Locations Count#

Retrieves a count of locations https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2020-10 | key: getLocationsCount

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Store Url

string
/ Required
storeUrl

Get Metafield#

Retrieves a single metafield from a resource by its ID. https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-10 | key: getMetafieldsParamMetafieldId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

MetafieldId

string
metafieldId

Store Url

string
/ Required
storeUrl

Get Metafields Count#

Retrieves a count of a resource's metafields. https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2020-10 | key: getMetafieldsCount

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Store Url

string
/ Required
storeUrl

Get Price Rules Batch#

Retrieves a discount code creation job https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-10 | key: getPriceRulesParamPriceRuleIdBatchParamBatchId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

BatchId

string
batchId

PriceRuleId

string
priceRuleId

Store Url

string
/ Required
storeUrl

Get Recurring Application Charge#

Retrieves a single charge https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#show-2020-10 | key: getRecurringApplicationChargesParamRecurringApplicationChargeId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

RecurringApplicationChargeId

string
recurringApplicationChargeId

Store Url

string
/ Required
storeUrl

Get Redirect#

Retrieves a single redirect https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2020-10 | key: getRedirectsParamRedirectId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

RedirectId

string
redirectId

Store Url

string
/ Required
storeUrl

Get Redirects Count#

Retrieves a count of URL redirects https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-10 | key: getRedirectsCount

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Path

data
path

Store Url

string
/ Required
storeUrl

Target

data
target

Get Report#

Retrieves a single report created by your app https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-10 | key: getReportsParamReportId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

ReportId

string
reportId

Store Url

string
/ Required
storeUrl

Get Theme Assets#

Retrieves a single asset for a theme by its key. To retrieve a single asset, include asset[key]=#{asset_key} as a request parameter. For example, to retrieve the asset with a key of templates/index.liquid, the request might be /admin/themes/828155753/assets.json?asset[key]=templates/index.liquid. For more information on the key property, see Asset properties. https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#show-2020-10 | key: getThemesParamThemeIdAssets

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

AssetKey

string
assetKey

Fields

data
fields

Store Url

string
/ Required
storeUrl

ThemeId

string
themeId

Get Webhooks#

Retrieves a single webhook subscription https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-10 | key: getWebhooksParamWebhookId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

Store Url

string
/ Required
storeUrl

WebhookId

string
webhookId

Get Webhooks Count#

Retrieves a count of existing webhook subscriptions https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-10 | key: getWebhooksCount

InputKeyNotesExample

AddressId

string
addressId

API Version

string
/ Required
apiVersion2020-10

Store Url

string
/ Required
storeUrl

Topic

data
topic

List Admin Oauth Access Scopes#

Retrieves a list of access scopes associated to the access token. https://shopify.dev/docs/admin-api/rest/reference/access/accessscope#index-2020-10 | key: getAdminOauthAccessScopes

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Store Url

string
/ Required
storeUrl

List Application Charges#

Retrieves a list of application charges https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-10 | key: getApplicationCharges

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

SinceId

data
sinceId

Store Url

string
/ Required
storeUrl

List Application Usage Charges#

Retrieves a list of usage charges https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#index-2020-10 | key: getRecurringApplicationChargesParamRecurringApplicationChargeIdUsageCharges

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

RecurringApplicationChargeId

string
recurringApplicationChargeId

Store Url

string
/ Required
storeUrl

List Article Authors#

Retrieves a list all of article authors https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2020-10 | key: getArticlesAuthors

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Store Url

string
/ Required
storeUrl

List Articles Tags#

Retrieves a list of all the tags https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2020-10 | key: getArticlesTags

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Limit

data
limit

Popular

data
popular

Store Url

string
/ Required
storeUrl

List Blog Articles#

Retrieves a list of all articles from a blog. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/online-store/article#index-2020-10 | key: getBlogsParamBlogIdArticles

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Author

data
author

BlogId

string
blogId

CreatedAtMax

data
createdAtMax

CreatedAtMin

data
createdAtMin

Fields

data
fields

Handle

data
handle

Limit

data
limit

PublishedAtMax

data
publishedAtMax

PublishedAtMin

data
publishedAtMin

PublishedStatus

data
publishedStatus

SinceId

data
sinceId

Store Url

string
/ Required
storeUrl

Tag

data
tag

UpdatedAtMax

data
updatedAtMax

UpdatedAtMin

data
updatedAtMin

List Customer Saved Searches#

Retrieves a list of customer saved searches. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-10 | key: getCustomerSavedSearches

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

Limit

data
limit

SinceId

data
sinceId

Store Url

string
/ Required
storeUrl

List Customers#

Retrieves a list of customers. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2020-10 | key: getCustomers

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CreatedAtMax

data
createdAtMax

CreatedAtMin

data
createdAtMin

Fields

data
fields

Ids

data
ids

Limit

data
limit

SinceId

data
sinceId

Store Url

string
/ Required
storeUrl

UpdatedAtMax

data
updatedAtMax

UpdatedAtMin

data
updatedAtMin

List Customers Addresses#

Retrieves a list of addresses for a customer. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-10 | key: getCustomersParamCustomerIdAddresses

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

Store Url

string
/ Required
storeUrl

List Customers Orders#

Retrieves all orders belonging to a customer. The query string parameters that are available to the order resource are also available to this endpoint. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#orders-2020-10 | key: getCustomersParamCustomerIdOrders

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

Store Url

string
/ Required
storeUrl

List Discount Codes#

Retrieve a list of discount codes. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#index-2020-10 | key: getPriceRulesParamPriceRuleIdDiscountCodes

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

PriceRuleId

string
priceRuleId

Store Url

string
/ Required
storeUrl

List Events#

Retrieves a list of events. Note: As of version 2019-07, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/events/event#index-2020-10 | key: getEvents

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CreatedAtMax

data
createdAtMax

CreatedAtMin

data
createdAtMin

Fields

data
fields

Filter

data
filter

Limit

data
limit

SinceId

data
sinceId

Store Url

string
/ Required
storeUrl

Verb

data
verb

List Inventory Items#

Retrieves a list of inventory items. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#index-2020-10 | key: getInventoryItems

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Ids

data
ids

IdsRequired

data
idsRequired

Limit

data
limit

Store Url

string
/ Required
storeUrl

List Inventory Levels#

Retrieves a list of inventory levels. You must include inventory_item_ids, location_ids, or both as filter parameters. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#index-2020-10 | key: getInventoryLevels

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

InventoryItemIds

data
inventoryItemIds

Limit

data
limit

LocationIds

data
locationIds

Store Url

string
/ Required
storeUrl

UpdatedAtMin

data
updatedAtMin

List Location Inventory#

Retrieves a list of inventory levels for a location. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/inventory/location#inventory_levels-2020-10 | key: getLocationsParamLocationIdInventoryLevels

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

LocationIds

data
locationIds

Store Url

string
/ Required
storeUrl

List Locations#

Retrieves a list of locations https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2020-10 | key: getLocations

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Store Url

string
/ Required
storeUrl

List Metafields#

Retrieves a list of metafields that belong to a Product Image resource. https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-10 | key: getMetafields

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

MetafieldOwnerId

data
metafieldOwnerId

MetafieldOwnerResource

string
metafieldOwnerResource

Store Url

string
/ Required
storeUrl

List Price Rules Batch Discount Codes#

Retrieves a list of discount codes for a discount code creation job. Discount codes that have been successfully created include a populated id field. Discount codes that encountered errors during the creation process include a populated errors field. https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-10 | key: getPriceRulesParamPriceRuleIdBatchParamBatchIdDiscountCodes

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

BatchId

string
batchId

PriceRuleId

string
priceRuleId

Store Url

string
/ Required
storeUrl

List Recurring Application Charges#

Retrieves a list of recurring application charges https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-10 | key: getRecurringApplicationCharges

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

SinceId

data
sinceId

Store Url

string
/ Required
storeUrl

List Redirects#

Retrieves a list of URL redirects. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-10 | key: getRedirects

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

Limit

data
limit

Path

data
path

SinceId

data
sinceId

Store Url

string
/ Required
storeUrl

Target

data
target

List Reports#

Retrieves a list of reports. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/analytics/report#index-2020-10 | key: getReports

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

Ids

data
ids

Limit

data
limit

SinceId

data
sinceId

Store Url

string
/ Required
storeUrl

UpdatedAtMax

data
updatedAtMax

UpdatedAtMin

data
updatedAtMin

List Storefront Access Tokens#

Retrieves a list of storefront access tokens that have been issued https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#index-2020-10 | key: getStorefrontAccessTokens

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Store Url

string
/ Required
storeUrl

List Webhooks#

Retrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-10 | key: getWebhooks

InputKeyNotesExample

AddressId

string
addressId

API Version

string
/ Required
apiVersion2020-10

CreatedAtMax

data
createdAtMax

CreatedAtMin

data
createdAtMin

Fields

data
fields

Limit

data
limit

SinceId

data
sinceId

Store Url

string
/ Required
storeUrl

Topic

data
topic

UpdatedAtMax

data
updatedAtMax

UpdatedAtMin

data
updatedAtMin

Perform Customer Saved Search#

Retrieves all customers returned by a customer saved search. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2020-10 | key: getCustomerSavedSearchesParamCustomerSavedSearchIdCustomers

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerSavedSearchId

string
customerSavedSearchId

Fields

data
fields

Limit

data
limit

Order

data
order

Store Url

string
/ Required
storeUrl

Search Customers#

Searches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2020-10 | key: getCustomersSearch

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

Fields

data
fields

Limit

data
limit

Order

data
order

Query

data
query

Store Url

string
/ Required
storeUrl

Send Customer Invite#

Sends an account invite to a customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2020-10 | key: createCustomersParamCustomerIdSendInvite

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Set Inventory Level#

Sets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations. https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel#set-2020-10 | key: createInventoryLevelsSet

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

AvailableRequired

data
availableRequired

DisconnectIfNecessary

data
disconnectIfNecessary

InventoryItemIdRequired

data
inventoryItemIdRequired

LocationIdRequired

data
locationIdRequired

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Update Blog Article#

Updates an article https://shopify.dev/docs/admin-api/rest/reference/online-store/article#update-2020-10 | key: updateBlogsParamBlogIdArticlesParamArticleId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

ArticleId

string
articleId

BlogId

string
blogId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Update Customer#

Updates a customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#update-2020-10 | key: updateCustomersParamCustomerId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Update Customer Saved Search#

Updates a customer saved search. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2020-10 | key: updateCustomerSavedSearchesParamCustomerSavedSearchId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

CustomerSavedSearchId

string
customerSavedSearchId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Update Customers Addresses#

Performs bulk operations for multiple customer addresses. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-10 | key: updateCustomersParamCustomerIdAddressesSet

InputKeyNotesExample

AddressIds

data
addressIds

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

Operation

string
operation

Store Url

string
/ Required
storeUrl

Update Default Customer Address#

Sets the default address for a customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#default-2020-10 | key: updateCustomersParamCustomerIdAddressesParamAddressIdDefault

InputKeyNotesExample

AddressId

string
addressId

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

Store Url

string
/ Required
storeUrl

Update Discount Code#

Updates an existing discount code https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#update-2020-10 | key: updatePriceRulesParamPriceRuleIdDiscountCodesParamDiscountCodeId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

DiscountCodeId

string
discountCodeId

PriceRuleId

string
priceRuleId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Update Existing Customers Addresses#

Updates an existing customer address. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2020-10 | key: updateCustomersParamCustomerIdAddressesParamAddressId

InputKeyNotesExample

AddressId

string
addressId

API Version

string
/ Required
apiVersion2020-10

CustomerId

string
customerId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Update Inventory Items#

Updates an existing inventory item https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#update-2020-10 | key: updateInventoryItemsParamInventoryItemId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

InventoryItemId

string
inventoryItemId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Update Metafield#

Updates a metafield. https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2020-10 | key: updateMetafieldsParamMetafieldId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

MetafieldId

string
metafieldId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Update Recurring Application Charge#

Updates the capped amount of an active recurring application charge https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#customize-2020-10 | key: updateRecurringApplicationChargesParamRecurringApplicationChargeIdCustomize

InputKeyNotes

RecurringApplicationChargeCappedAmount

data
recurringApplicationChargeCappedAmount

RecurringApplicationChargeId

string
recurringApplicationChargeId

Store Url

string
/ Required
storeUrl

Update Report#

Updates a report https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-2020-10 | key: updateReportsParamReportId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

ReportId

string
reportId

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

Update Theme#

Updates an existing theme. https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#update-2020-10 | key: updateThemesParamThemeId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

ThemeId

string
themeId

Update Theme Assets#

Creates or updates an asset for a theme. In the PUT request, you can include the src or source_key property to create the asset from an existing file. https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#update-2020-10 | key: updateThemesParamThemeIdAssets

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

SourceKey

data
sourceKey

Src

data
src

Store Url

string
/ Required
storeUrl

ThemeId

string
themeId

Update Webhooks#

Update a webhook subscription's topic or address URIs https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-10 | key: updateWebhooksParamWebhookId

InputKeyNotesExample

API Version

string
/ Required
apiVersion2020-10

RequestBody

data
requestBody

Store Url

string
/ Required
storeUrl

WebhookId

string
webhookId