Versions Compared

Version Old Version 18 New Version Current
Changes made by

Gouri Bhagchandani

Gouri Bhagchandani

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

Field NameField DescriptionDescription
Label*N/A

Specify a unique label for the account.

Default Value: N/A
Example: Shopify-OAuth2

Store Name*N/A

Specify the store name for which you want to create the account.

Default Value: N/A
Example: demo-store-sl

Client ID*N/A

Specify the client ID associated with your Shopify application. You can create the client ID as advised by your application provider.  See Shopify documentation for more information.

Default Value: N/A
Example: 1abcd23e-45fg-6789-hi01-23456jk789l0

Client SecretsecretN/A

Specify the client secret associated with your account. You can create the client secret as advised by your application provider. The client secret is securely stored in SnapLogic's cloud data warehouse. See Shopify documentation for more information.

Default Value: N/A
Example: axsf9242f9nsh67f2276b9ws4cadd14

Access TokentokenN/A

Auto-generated upon account authorization. The access token associated with the Shopify application is used to make API requests on behalf of the user associated with the client ID.

Note

The access token might be refreshable, in that case an optional refresh token can be stored. You must get a new access token if the access token has expired and no refresh token was defined or both the access and the refresh token have expired.

Default Value: N/A
Example: N/A

Refresh TokentokenN/A

Auto-generated upon account authorization. The token used to refresh the access token.

Info

If the refresh token is stored, then the access token can be refreshed automatically before it expires.

Default Value: N/A
Example: N/A

Access Token Expirationtoken expirationN/A

Auto-generated upon account authorization. The access token expiration value.

Default Value: N/A
Example: -1

OAuth2 Endpointauthorization endpoint*N/A

Enter the authorization endpoint to authorize the application.

Default Value: N/A
Example: https://store87.myshopify.com/admin/oauth/authorize

OAuth2 Tokentoken endpoint*N/A

Specify the token endpoint to get the access token.

Default Value: N/A
Example: Shopify-OAuth2

Auth Endpoint Authorization endpoint config

Use this field set to define custom properties for OAuth2 endpoint. This field set contains the following fields:

  • Authentication Parameter
  • Authentication Parameter Value
Authentication ParameterparameterN/A

Specify the name for the token endpoint parameter.

Default Value: N/A
Example: Scope

Authentication Parameter Valueparameter valueN/A

Specify the value for the parameter.

Default Value: N/A
Example: read_orders, write_orders

Auto-refresh tokenN/A

Select this checkbox to refresh the token automatically if the Refresh Token field is enabled. If you deselect this checkbox, the token might expire and will not be refreshed automatically.

Default Value: N/A
Example: Shopify-OAuth2

AuthorizeN/A

Click this button to acquire the required permissions for this account when creating an account.

For existing accounts, you can click this button to re-acquire the permissions (Access token, Refresh token, and Access token expiration) to ensure that the account works as expected. This action does not require or result in any changes to the Access token that is already generated.

Troubleshooting

ErrorReasonResolution
"400 Bad Request"

The request was not understood by the server, generally due to bad syntax or because the Content-Type header was not correctly set to application/json. 
This status is also returned when the request provides an invalid code parameter during the OAuth token exchange process.

Enter valid token details.

"401 Unauthorized"The necessary authentication credentials are not present in the request or are incorrect.Enter valid authentication credentials.
"403 Forbidden"The server is refusing to respond to the request. This is generally because you have not requested the appropriate scope for this action.Request for the scope that is defined in your account.

...