Skip to content

Admin API v3

Active LTS

Admin v3 API will remain in Active Long Term Support until 2026-12-31, after which it will reach End of Life. For information on upgrading to Admin v4, please refer to the upgrade guide.

New features

  • Multi-lingual support for markets
  • Long-running imports

Changes

This section lists changes from API 2 that must be considered when upgrading.

The listed changes are limited to the resources found in the Admin API, changes related to Queries and unauthorized Notifications are found in the Storefront API.

Endpoints New value Previous value Description
All /api/admin/v{major}/{resource} /api/v{1-2}/{resource} Path pattern changed.
import/pages
export/pages		 headings heading Page schema updated, structure changed to map of locale to heading.
import/pages
export/pages		 paths N/A Page schema updated, added support fo map of locale to page paths.
import/pages
export/pages		 additional additional Page schema updated, structure changed to map of locale to keywords.
import/navigation
export/navigation		 locale N/A Navigation schema updated, added required locale.
import/data 202 after timeout Error after timeout Response updated, supporting long running imports.
import/data blockingTimeout N/A Optional query parameter added.
import/status New endpoint N/A Supports status for long running imports.

Resources

Downloadable utility resources.

Endpoints

Import

Export

Event data

Notifications

Status

×
Copyright

This online publication is intellectual property of Voyado Lund AB. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Voyado Lund AB nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Voyado Lund AB essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE