To use the Vend connector, add the <vend.init>
element in your configuration before carrying out any other Vend operations.
The Vend API allows authorisation using the OAuth 2.0 standard. For more information, see https://developers.vendhq.com/documentation/oauth.html#oauth.
<vend.init> <apiUrl>{$ctx:apiUrl}</apiUrl> <accessToken>{$ctx:accessToken}</accessToken> </vend.init>
Properties
apiUrl:
The base endpoint URL of the Vend API.accessToken:
OAuth Token to read and manipulate data of the Vend account.
Note
<vend.getAccessTokenFromAuthorizationCode> <apiUrl>{$ctx:apiUrl}</apiUrl> <authorizationCode>{$ctx:authorizationCode}</authorizationCode> <redirectUrl>{$ctx:redirectUrl}</redirectUrl> </vend.getAccessTokenFromAuthorizationCode>
Properties
The base end point URL of the Vend API.apiUrl:
Authorization code to be used to obtain the access token.authorizationCode:
Redirect URL to be used in the OAuth 2.0 authorization flow.redirectUrl:
Following is a sample REST/JSON request that can be handled by the getAccessTokenFromAuthorizationCode
operation.
{ "apiUrl": "https://hormondri.vendhq.com", "authorizationCode": "https://hormondri.vendhq.com", "redirectUrl": "http://www.krishantha.net" }
Related Vend documentation
https://developers.vendhq.com/documentation/oauth.html#oauth
<vend.getAccessTokenFromRefreshToken> <apiUrl>{$ctx:apiUrl}</apiUrl> </vend.getAccessTokenFromRefreshToken>
Properties
The base end point URL of the Vend API.apiUrl:
Following is a sample REST/JSON request that can be handled by the getAccessTokenFromRefreshToken
operation.
{ "apiUrl": "https://hormondri.vendhq.com" }
Related Vend documentation
https://developers.vendhq.com/documentation/oauth.html#oauth
Now that you have connected to Vend, use the information in the following topics to perform various operations with the connector.