Articles on: Shopify

Rest API connection method

Before setting up a connection to the Rest API feed, test the request with software such as Postman to confirm that the endpoint can retrieve products. The API endpoint itself must be accessible to Stock Sync; API documentation or a Swagger page alone is not sufficient.



If the endpoint is inaccessible, ask the supplier to make the API URL reachable and check whether Stock Sync’s server IP, 52.20.189.51, must be whitelisted. If you cannot test the request, provide the API documentation and credentials securely.


  1. Fill in the endpoint URL based on your API request.
  2. Select the Authorization Type needed for that API request. There are a few types of authorization which are Basic Auth, Bearer Token, Oauth2, and No Auth.


a) Basic Auth


This authorization method involves username and password only. When your API request with username and password you can select Basic Auth.



b) Bearer Token


A bearer token is another method of authorization that uses tokens from your API. So that, you can fill up the token in the required field.



c) Oauth2


Oauth2 is to provide consented access and restrict actions of what the client app can perform on resources on behalf of the user, without sharing the user's credentials. So certain APIs use this method to secure their authorization. If your API URL, using this method please select this and insert all the respective details.



d) Oauth2 with password


Oauth2 is to provide consented access and restrict actions of what the client app can perform on resources on behalf of the user, without sharing the user's credentials. So certain APIs use this method to secure their authorization with password. If your API URL, using this method please select this and insert all the respective details.



  1. If there are any header params or query params that need to be keyed in for that API request and fill in the given field.  To know more about the query param and header param, refer here.
  2. For the  Body Raw is defined as the filter part. If you wanted to filter any collection or Category from the Rest API. You may use Body Raw to enter the filter category or collections as well in the provided field.
  3. Choose the HTTP method:


  • GET: retrieves information from the server
  • PUT: used to create
  • POST: accept the data enclosed in the body of the request message, most likely for storing it


  1. Ensure the correct File Format.


Information required to set up a new API feed


To configure a REST API feed for a Shopify store, first test the API request with an API client such as Postman to confirm that it can retrieve products. Then provide or enter the following details:


  1. API documentation
  2. API URL / endpoint
  3. Authorization details—API key, token, username and password, or OAuth credentials
  4. Any required header, query, or body parameters
  5. The required HTTP method and file format (JSON or XML)


In the feed settings, enter the endpoint URL, choose the authorization type required by the API (Basic Auth, Bearer Token, OAuth2, OAuth2 with password, or No Auth), add any required headers or query parameters, and use Body Raw for filters such as categories or collections. Choose the appropriate HTTP method and file format.


Stock Sync currently supports REST API connections for custom feeds. REST API feeds can use GET, POST, or PUT requests and JSON or XML responses, with headers, query parameters, request bodies, pagination, and authentication such as No Auth, Basic Auth, Bearer Token, OAuth2, or OAuth2 with password.


GraphQL is not currently available as a self-service connection method. GraphQL support has been described as in development, but there is no confirmed release date. If a supplier offers GraphQL only, check whether it also provides a REST API endpoint or use another supported source method.


Other supported data-source methods include FTP/SFTP, Google Sheets, Dropbox, and downloadable HTTP/HTTPS URLs. For FTP connections that retrieve multiple files, the files must use the same column names in the same order and structure.


Before requesting a custom API feed, test the request with an API client such as Postman and provide the API documentation, accessible endpoint, authentication details, required parameters, request method, file format, pagination information, and a representative response. Custom connections may require backend configuration and testing.


Stock Sync currently supports REST API connections for custom feeds.

Updated on: 06/08/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!