component icon for Shopify
Shopify Connector

Quickly deliver Shopify integrations to your users.

About the Shopify Connector

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

Documentation

Connector Actions

Action NameAction Description
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
Create Storefront Access Tokens Creates a new storefront access token https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#create-2020-10
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
Delete Storefront Access Token Deletes an existing storefront access token https://shopify.dev/docs/admin-api/rest/reference/access/storefrontaccesstoken#destroy-2020-10
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
Create Report Creates a new report https://shopify.dev/docs/admin-api/rest/reference/analytics/report#create-2020-10
Get Report Retrieves a single report created by your app https://shopify.dev/docs/admin-api/rest/reference/analytics/report#show-2020-10
Update Report Updates a report https://shopify.dev/docs/admin-api/rest/reference/analytics/report#update-2020-10
Delete Report Deletes a report https://shopify.dev/docs/admin-api/rest/reference/analytics/report#destroy-2020-10
Create Application Charge Creates an application charge https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#create-2020-10
List Application Charges Retrieves a list of application charges https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-10
Get Application Charge Retrieves an application charge https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#show-2020-10
Create Application Credit Creates an application credit https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-10
Get Application Credits Retrieves all application credits https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#index-2020-10
Get Application Credit Retrieves a single application credit https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-10
Create Recurring Application Charges Creates a recurring application charge https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#create-2020-10
List Recurring Application Charges Retrieves a list of recurring application charges https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-10
Get Recurring Application Charge Retrieves a single charge https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#show-2020-10
Delete Recurring Application Charge Cancels a recurring application charge https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#destroy-2020-10
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
Create Application Usage Charge Creates a usage charge https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2020-10
List Application Usage Charges Retrieves a list of usage charges https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#index-2020-10
Get Application Usage Charge Retrieves a single charge https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#show-2020-10
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
Create Customer Creates a customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#create-2020-10
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
Get Customer Retrieves a single customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#show-2020-10
Update Customer Updates a customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#update-2020-10
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
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
Send Customer Invite Sends an account invite to a customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2020-10
Get Customers Count Retrieves a count of all customers. https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2020-10
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
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
Create Customer Address Creates a new address for a customer. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2020-10
Get Customer Address Retrieves a single customer address. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2020-10
Update Existing Customers Addresses Updates an existing customer address. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2020-10
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
Update Customers Addresses Performs bulk operations for multiple customer addresses. https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-10
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
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
Create Customer Saved Search Creates a customer saved search. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2020-10
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
Get Customer Saved Search Retrieves a single customer saved search. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2020-10
Update Customer Saved Search Updates a customer saved search. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2020-10
Delete Customer Saved Search Deletes a customer saved search. https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2020-10
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
Create Discount Code Creates a discount code https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#create-2020-10
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
Update Discount Code Updates an existing discount code https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#update-2020-10
Get Discount Code Retrieves a single discount code https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#show-2020-10
Delete Discount Code Deletes a discount code https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#destroy-2020-10
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
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
Get Price Rules Batch Retrieves a discount code creation job https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-10
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
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
Get Event Retrieves a single event by its ID https://shopify.dev/docs/admin-api/rest/reference/events/event#show-2020-10
Get Events Count Retrieves a count of events https://shopify.dev/docs/admin-api/rest/reference/events/event#count-2020-10
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
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
Get Webhooks Count Retrieves a count of existing webhook subscriptions https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-10
Get Webhooks Retrieves a single webhook subscription https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-10
Update Webhooks Update a webhook subscription's topic or address URIs https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-10
Delete Webhook Delete a webhook subscription https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-2020-10
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
Get Inventory Items Retrieves a single inventory item by ID https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#show-2020-10
Update Inventory Items Updates an existing inventory item https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem#update-2020-10
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
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
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
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
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
List Locations Retrieves a list of locations https://shopify.dev/docs/admin-api/rest/reference/inventory/location#index-2020-10
Get Locations Retrieves a single location by its ID https://shopify.dev/docs/admin-api/rest/reference/inventory/location#show-2020-10
Get Locations Count Retrieves a count of locations https://shopify.dev/docs/admin-api/rest/reference/inventory/location#count-2020-10
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
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
Create Metafield Creates a new metafield for a resource. https://shopify.dev/docs/admin-api/rest/reference/metafield#create-2020-10
Get Metafields Count Retrieves a count of a resource's metafields. https://shopify.dev/docs/admin-api/rest/reference/metafield#count-2020-10
Get Metafield Retrieves a single metafield from a resource by its ID. https://shopify.dev/docs/admin-api/rest/reference/metafield#show-2020-10
Update Metafield Updates a metafield. https://shopify.dev/docs/admin-api/rest/reference/metafield#update-2020-10
Delete Metafield Deletes a metafield by its ID. https://shopify.dev/docs/admin-api/rest/reference/metafield#destroy-2020-10
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
Create Blog Articles Creates an article for a blog https://shopify.dev/docs/admin-api/rest/reference/online-store/article#create-2020-10
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
Get Blog Article Retrieves a single article https://shopify.dev/docs/admin-api/rest/reference/online-store/article#show-2020-10
Update Blog Article Updates an article https://shopify.dev/docs/admin-api/rest/reference/online-store/article#update-2020-10
Delete Blog Article Deletes an article https://shopify.dev/docs/admin-api/rest/reference/online-store/article#destroy-2020-10
List Article Authors Retrieves a list all of article authors https://shopify.dev/docs/admin-api/rest/reference/online-store/article#authors-2020-10
List Articles Tags Retrieves a list of all the tags https://shopify.dev/docs/admin-api/rest/reference/online-store/article#tags-2020-10
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
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
Delete Theme Assets Deletes an asset from a theme. https://shopify.dev/docs/admin-api/rest/reference/online-store/asset#destroy-2020-10
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
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, a path of 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
Get Redirects Count Retrieves a count of URL redirects https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-10
Get Redirect Retrieves a single redirect https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2020-10
Update Redirect Updates an existing redirect https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2020-10
Delete Redirect Deletes a redirect https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2020-10
List Script Tags Retrieves a list of all script tags. 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/scripttag#index-2020-10
Create Script Tags Creates a new script tag https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#create-2020-10
Get Script Tags Count Retrieves a count of all script tags https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#count-2020-10
Get Script Tag Retrieves a single script tag https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#show-2020-10
Update Script Tag Updates a script tag https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#update-2020-10
Delete Script Tag Deletes a script tag https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag#destroy-2020-10
List Themes Retrieves a list of themes. https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#index-2020-10
Create Theme Creates a theme by providing the public URL of a ZIP file that contains the theme. A new theme is always unpublished by default. To publish a theme when you create it, include "role": "main" in the POST request. The theme will be published only after all of its files have been extracted and stored by Shopify, which might take a couple of minutes. https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#create-2020-10
Get Theme Retrieves a single theme. https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#show-2020-10
Update Theme Updates an existing theme. https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#update-2020-10
Delete Theme Deletes a theme. https://shopify.dev/docs/admin-api/rest/reference/online-store/theme#destroy-2020-10
Get Checkouts Count Retrieves a count of checkouts from the past 90 days https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts#count-2020-10
Create Order Creates an order risk for an order https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#create-2020-10
List Order Risks Retrieves a list of all order risks for an order. 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/orders/order-risk#index-2020-10
Get Order Risk Retrieves a single order risk by its ID https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#show-2020-10
Update Order Risk Updates an order risk Note You cannot modify an order risk that was created by another application. https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#update-2020-10
Delete Order Risk Deletes an order risk for an order Note You cannot delete an order risk that was created by another application. https://shopify.dev/docs/admin-api/rest/reference/orders/order-risk#destroy-2020-10
List Order Refunds Retrieves a list of refunds for an order. 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/orders/refund#index-2020-10
Create Order Refund Caution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Creates a refund. Use the calculate endpoint to produce the transactions to submit. Note When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute. https://shopify.dev/docs/admin-api/rest/reference/orders/refund#create-2020-10
Get Order Refund Retrieves a specific refund. https://shopify.dev/docs/admin-api/rest/reference/orders/refund#show-2020-10
Calculate Order Refund Caution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with "kind": "suggested_refund", which must to be changed to "kind" : "refund" for the refund to be accepted. https://shopify.dev/docs/admin-api/rest/reference/orders/refund#calculate-2020-10
List Gift Cards Retrieves a list of gift cards. 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/plus/giftcard#index-2020-10
Create Gift Card Creates a gift card https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#create-2020-10
Get Gift Card Retrieves a single gift card by its ID https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#show-2020-10
Update Gift Card Updates an existing gift card. The gift card's balance can't be changed via the API. You can change only the expiry date, note, and template suffix. https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#update-2020-10
Get Gift Cards Count Retrieves a count of gift cards https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#count-2020-10
Disable Gift Card Disables a gift card. Disabling a gift card can't be undone. https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#disable-2020-10
Search Gift Cards Searches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters 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/plus/giftcard#search-2020-10
List Users Retrieves a list of all users. Note: As of version 2021-01, 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/plus/user#index-2020-10
Get User Retrieves a single user https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-10
Get Current User Retrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop. https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-10
Create Collect Adds a product to a custom collection. https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2020-10
List Collects Retrieves a list of collects. 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/products/collect#index-2020-10
Delete Collect Removes a product from a collection. https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2020-10
Get Collect Retrieves a specific collect by its ID. https://shopify.dev/docs/admin-api/rest/reference/products/collect#show-2020-10
Get Collects Count Retrieves a count of collects. https://shopify.dev/docs/admin-api/rest/reference/products/collect#count-2020-10
Get Collection Retrieves a single collection https://shopify.dev/docs/admin-api/rest/reference/products/collection#show-2020-10
List Collection Products Retrieve a list of products belonging to a collection. 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.. The products returned are sorted by the collection's sort order. https://shopify.dev/docs/admin-api/rest/reference/products/collection#products-2020-10
List Custom Collections Retrieves a list of custom collections. 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/products/customcollection#index-2020-10
Create Custom Collection Creates a custom collection https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2020-10
Get Custom Collections Count Retrieves a count of custom collections https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-10
Get Custom Collections Retrieves a single custom collection https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2020-10
Update Custom Collection Updates an existing custom collection https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2020-10
Delete Custom Collection Deletes a custom collection https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2020-10
List Products Retrieves a list of products. 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/products/product#index-2020-10
Create Product Creates a new product. If you want to set the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag. https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2020-10
Get Products Count Retrieves a count of products. https://shopify.dev/docs/admin-api/rest/reference/products/product#count-2020-10
Get Products Retrieves a single product. https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2020-10
Update Product Updates a product and its variants and images. If you want to update the product's SEO information, then you can use the following properties: metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the <meta name='title'> tag. metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the <meta name='description'> tag. https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2020-10
Delete Product Deletes a product. https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2020-10
list Product Images Get all product images https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2020-10
Create Product Image Create a new product image https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2020-10
Get Product Images Count Get a count of all product images https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-10
Get Product Image Get a single product image by id https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-10
Update Product Image Modify an existing product image https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-10
Delete Product Image https://shopify.dev/docs/admin-api/rest/reference/products/product-image#destroy-2020-10
List Smart Collections Retrieves a list of smart collections. 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/products/smartcollection#index-2020-10
Create Smart Collection Creates a new smart collection using the specified rules. https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#create-2020-10
Get Smart Collections Count Retrieves a count of smart collections https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-10
Get Smart Collection Retrieves a single smart collection https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#show-2020-10
Update Smart Collection Updates an existing smart collection https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#update-2020-10
Delete Smart Collection Removes a smart collection https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#destroy-2020-10
Update Smart Collection Order Updates the ordering type of products in a smart collection https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#order-2020-10
Create Checkouts Creates a checkout https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#create-2020-10
Complete Checkout Completes a checkout https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#complete-2020-10
Get Checkout Retrieves a checkout https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#show-2020-10
Update Checkout Modifies an existing checkout https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#update-2020-10
List Checkout Shipping Rates Retrieves a list of available shipping rates for the specified checkout. Implementers need to poll this endpoint until rates become available. Each shipping rate contains the checkout's new subtotal price, total tax, and total price in the event that this shipping rate is selected. This can be used to update the UI without performing further API requests. To apply a shipping rate, update the checkout's shipping line with the handle of the selected rate. https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-10
Get All Collection Listings Retrieve collection listings that are published to your app. 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/sales-channels/collectionlisting#index-2020-10
Get Product In Collection List Retrieve product_ids that are published to a collection_id. 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/sales-channels/collectionlisting#product_ids-2020-10
Get Collection Listing Retrieve a specific collection listing that is published to your app https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#show-2020-10
Update Collection Listing Create a collection listing to publish a collection to your app https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#create-2020-10
Delete Collection Listing Delete a collection listing to unpublish a collection from your app https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting#destroy-2020-10
Create Checkout Payment Creates a payment on a checkout using the session ID returned by the card vault https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-10
List Checkout Payments Retrieves a list of payments on a particular checkout https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-10
Get Checkout Payment Retrieves the payment information for an existing payment https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-10
Get Checkout Payments Count Counts the number of payments attempted on a checkout https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-10
List Assigned Fulfillment Orders Retrieves a list of fulfillment orders on a shop for a specific app. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/assignedfulfillmentorder#index-2020-10
Create Fulfillment Order Cancellation Request Sends a cancellation request to the fulfillment service of a fulfillment order. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#create-2020-10
Accept Fulfillment Order Cancellation Request Accepts a cancellation request sent to a fulfillment service for a fulfillment order. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#accept-2020-10
Reject Fulfillment Order Cancellation Request Rejects a cancellation request sent to a fulfillment service for a fulfillment order. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/cancellationrequest#reject-2020-10
Create Carrier Service Creates a carrier service https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#create-2020-10
List Carrier Service Retrieves a list of carrier services https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#index-2020-10
Update Carrier Service Updates a carrier service. Only the app that creates a carrier service can update it. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#update-2020-10
Get Carrier Service Retrieves a single carrier service by its ID https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#show-2020-10
Delete Carrier Service Deletes a carrier service https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice#destroy-2020-10
List Order Fulfillments Retrieves fulfillments associated with an order. 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/shipping-and-fulfillment/fulfillment#index-2020-10
Create Order Fulfillment Create a fulfillment for the specified order and line items. The fulfillment's status depends on the line items in the order: If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately. If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked. A fulfillment might then transition to open, which implies it is being processed by the service, before transitioning to success when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled. All line items being fulfilled must have the same fulfillment service. Note If you are using this endpoint with a Partner development store or a trial store, then you can create no more than 5 new fulfillments per minute. About tracking urls If you're creating a fulfillment for a supported carrier, then you can send the tracking_company and tracking_numbers fields, and Shopify will generate the tracking_url for you. If you're creating a fulfillment for an unsupported carrier (not in the tracking_company list), then send the tracking_company, tracking_numbers, and tracking_urls fields. Note If you send an unsupported carrier without a tracking URL, then Shopify will still try to generate a valid tracking URL by using pattern matching on the tracking number. However, Shopify does not validate the tracking URL, so you should make sure that your tracking URL is correct for the order and fulfillment. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#create-2020-10
List Fulfillment Order Fulfillments Retrieves fulfillments associated with a fulfillment order. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#indexV2-2020-10
Get Order Fulfillments Count Retrieves a count of fulfillments associated with a specific order https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#count-2020-10
Get Fulfillment Retrieve a specific fulfillment https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#show-2020-10
Update Fulfillment Update information associated with a fulfillment https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update-2020-10
Create Fulfillment Creates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#createV2-2020-10
Update Fulfillment Tracking Updates the tracking information for a fulfillment. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#update_tracking-2020-10
Complete Fulfillment Mark a fulfillment as complete https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#complete-2020-10
Open Fulfillment Mark a fulfillment as open https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#open-2020-10
Cancel Fulfillment Cancel a fulfillment for a specific order ID https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancel-2020-10
Cancel Fulfillments Cancels a fulfillment. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment#cancelV2-2020-10
List Order Fulfillment Events Retrieves a list of fulfillment events for a specific fulfillment https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#index-2020-10
Create Order Fulfillment Events Creates a fulfillment event https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#create-2020-10
Get Order Fulfillment Event Retrieves a specific fulfillment event https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#show-2020-10
Delete Order Fulfillment Event Deletes a fulfillment event https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentevent#destroy-2020-10
List Order Fulfillment Orders Retrieves a list of fulfillment orders for a specific order. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#index-2020-10
Get Fulfillment Order Retrieves a specific fulfillment order. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#show-2020-10
Cancel Fulfillment Order Marks a fulfillment order as cancelled. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#cancel-2020-10
Close Fulfillment Order Marks an in progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#close-2020-10
Move Fulfillment Order Moves a fulfillment order from one merchant managed location to another merchant managed location. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder#move-2020-10
Create Fulfillment Order Fulfillment Request Sends a fulfillment request to the fulfillment service of a fulfillment order. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#create-2020-10
Accept Fulfillment Order Fulfillment Request Accepts a fulfillment request sent to a fulfillment service for a fulfillment order. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#accept-2020-10
Reject Fulfillment Orders Request Rejects a fulfillment request sent to a fulfillment service for a fulfillment order. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentrequest#reject-2020-10
Get Fulfillment Services https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#index-2020-10
Create Fulfillment Service To create a fulfillment service, you can also use a cURL request that uses that fulfillment_service.json payload: Copy curl -X POST -d @fulfillment_service.json -H"Accept:application/json" -H"Content-Type:application/json" -H"X-Shopify-Access-Token:THE_TOKEN_GOES_HERE" https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services Where THE_TOKEN_GOES_HERE is replaced by the OAuth token given to you by Shopify and https://AUTHORIZED_SHOP.myshopify.com/admin/fulfillment_services is replaced by the authorized shop's URL. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#create-2020-10
Get Fulfillment Service https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#show-2020-10
Update Fulfillment Service https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#update-2020-10
Delete Fulfillment Service https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice#destroy-2020-10
List Fulfillment Order Locations For Move Retrieves a list of locations that a fulfillment order can potentially move to. The resulting list is sorted alphabetically in ascending order by location name. https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/locationsformove#index-2020-10
Get Shopify Payments Balance Retrieves the account's current balance. https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance#show-2020-10
List Shopify Payments Payouts Retrieves a list of all payouts ordered by payout date, with the most recent being first. 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/shopify_payments/payout#index-2020-10
Get Shopify Payments Payout Retrieves a single payout by id. https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#show-2020-10
List Countries Retrieves a list of countries. https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#index-2020-10
Create Country Caution As of version 2020-10, the tax field is deprecated. Creates a country. https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#create-2020-10
Get Countries Count Retrieves a count of countries. https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#count-2020-10
Get Country Retrieves a specific county. https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#show-2020-10
Update Country Caution As of version 2020-10, the tax field is deprecated. Updates an existing country. https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#update-2020-10
Delete Country Deletes a country. https://shopify.dev/docs/admin-api/rest/reference/store-properties/country#destroy-2020-10
List Currencies Retrieves a list of currencies enabled on a shop https://shopify.dev/docs/admin-api/rest/reference/store-properties/currency#index-2020-10
List Policies Retrieves a list of the shop's policies https://shopify.dev/docs/admin-api/rest/reference/store-properties/policy#index-2020-10
List Country Provinces Retrieves a list of provinces https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#index-2020-10
Get Country Provinces Count Retrieves a count of provinces for a country https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#count-2020-10
Get Country Province Retrieves a single province for a country https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#show-2020-10
Update Country Province Caution As of version 2020-10, the tax field is deprecated. Updates an existing province for a country. https://shopify.dev/docs/admin-api/rest/reference/store-properties/province#update-2020-10
List Shipping Zones Get a list of all shipping zones https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-10
Get Shop Config Retrieves the shop's configuration https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop#show-2020-10
List Tender Transactions Retrieves a list of tender transactions. 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/tendertransaction#index-2020-10

The Embedded Integration Platform for B2B Software Companies

Prismatic is a complete integration solution for B2B software companies. It's the easiest way to build and manage integrations for your customers.
icon

Purpose-Built Infrastructure

Run your integrations in a scalable, secure environment.

icon

Intuitive Integration Designer

Create integrations in a low-code environment tailored for your product.

icon

Pre-Built & Custom Components

Use built-in API connectors or build your own full-fledged custom components.

icon

Integration Deployment & Support

Easily manage customer-specific credentials, setup, and support.

icon

Embeddable Customer Experience

Provide a sleek integration marketplace and self-service tools.

icon

Built In A Way Devs Love

Fit the platform to your product and the way you build software.

Get in Touch

Looking for an additional component action? Want to see a tailored demo? Let us know and we'll be in touch soon!