When you add a Partner ID to your store's API access list, the token generated is valid for one year. When a token is coming up for expiration, either you or the partner must renew this token for the partner to have continued access to make API calls for your store.
Note: Merchant Solutions APIs are available with Merchant Solutions Standard, Merchant Solutions Professional, and Store v.1 plans. They aren't available with Merchant Solutions Starter.
Merchant renews partner token
You can renew partner tokens using the API Settings tool, located in the Real-Time Links section of Store Manager. Once partner access is renewed, a new token will display in the Control Panel. The new token will also be available to the partner in their Manage Partner Tokens tool. If needed, you can email a copy to the partner.
Please note: The partner must begin using this new token before the original partner token expires. Using the original partner token after its expiration date will result in failed API calls.
- Sign in to your My Services page.
- Click the Store link.
/msdyn_blobfile/$value)
- Go to Real-Time Links.
/msdyn_blobfile/$value)
- Go to API Settings.
/msdyn_blobfile/$value)
- In the Partner API Access table, select the checkbox next to the partner token you want to renew. Click the Renew Selected checkbox.
/msdyn_blobfile/$value)
Note: Tokens that are marked as RENEWED will not be selectable. If you wish to renew a token, select the token marked as NEW. - A Renew Partner Token(s) dialog box will open. You can set a custom expiration date for the new token using the calendar widget. Click the Renew button.
/msdyn_blobfile/$value)
Note: Tokens can be set to expire a minimum of one day from the token renewal date, up to a maximum of five years from the token renewal date. If a custom expiration date isn't selected, the token expiration date will be one year from the date of token renewal, by default.
A new partner token will be generated, and appear in the token list marked as New. The original token will be marked as Renewed.
/msdyn_blobfile/$value)
Important! If a renewed token is not authenticating, first verify with the partner that the API has been updated correctly with the new token. If this has been verified, and your renewed token still does not authenticate, you will need to revoke all tokens for that partner. Then re-add the partner to create a new working token.
Partner renews partner token
Partners can renew their partner tokens using the Manage Partner Tokens tool.
- Sign into the Manage Partner Tokens tool.
- All active tokens are listed in the Active Tokens tab. Tokens expiring within the next 30 days are also listed in the Expiring Tokens tab. Select the token(s) you want to renew using the corresponding Select checkbox. Click the Renew Selected checkbox.
/msdyn_blobfile/$value)
Note: Tokens that are marked as RENEWED will not be selectable. If you wish to renew a token, select the token marked as NEW. - A Renew Partner Token(s) dialog box will open. You can set a custom expiration date for the new token using the calendar widget. Click the Renew button.
/msdyn_blobfile/$value)
Note: Tokens can be set to expire a minimum of one day from the token renewal date, up to a maximum of five years from the token renewal date. If a custom expiration date isn't selected, the token expiration date will be one year from the date of token renewal, by default.
A new partner token will be generated, and appear in the token list marked as New. The original token will be marked as Renewed.
/msdyn_blobfile/$value)
New token information will display in the Manage Partner Tokens tool. The merchant will also see the new token in the API Settings Control Panel.
Important! If a renewed token is not authenticating, first verify that the API has been updated correctly with the new token. If this has been verified, and the renewed token still does not authenticate, please reach out to the merchant. They will need to revoke all tokens connected to your API. Then they will need to re-add you to create a new working token.
See Also:
