API access
Connect your systems through scoped shop access
Create API access for your shop and use documented endpoints to exchange business data.
Connect supported shop data to your other systems
- Your shop’s access
Manage API access from the shop workspace.
- Documented resources
Consult the available catalogue, order and marketing API documentation.
- Connected systems
Exchange data through supported endpoints instead of re-entering it by hand.
Prepare access for a specific use
Manage API access from the shop workspace and consult the documentation for the available resources. A connection should start with the data and operation you need, rather than assuming every application screen has an equivalent endpoint.
Use the available permissions to match access to that purpose. Keep credentials within the system that needs them and maintain the access record when the connected workflow changes.
Define access around the exchange you need
An access record for the shop. Create and maintain the API access in the selected workspace. Keep credentials within the system that actually needs the connection.
Permissions with a purpose. Use the available permissions for the intended operation. A connection should not assume every application screen has an equivalent endpoint.
Documented request formats. Read the resource’s supported operations and response format before exchanging data. Your implementation must handle the reported result.
Build around the documented resources
The supported catalogue, order and marketing resources allow your technical team to exchange data without repeating the same entry by hand. Their documentation defines the available operations and request formats.
An API provides building blocks, not an automatically installed connector for every service. Your team must implement the exchange, handle responses and test the intended workflow before relying on it for business operations.
Build a connection from documented operations
Choose the business exchange. Identify the catalogue, order or supported marketing data needed. Start from its documentation rather than inventing a connector contract.
Prepare the access. Create the appropriate access record and apply supported permissions. Check the selected shop before connecting another system.
Test the actual operation. Implement the request and inspect its response before relying on the workflow. API access supplies building blocks, not an automatically installed integration.
Give your shop room to connect with a wider workflow
Prepare documented access for the systems that support your business.
Questions about API access
In the shop workspace's API access area, with the appropriate account permissions.
Do not assume that. Use the published resource and operation documentation.
Available documentation covers supported catalogue, order and marketing resources.
Use the supported access permissions rather than giving a connection more access than its purpose requires.
No. It prepares credentials; the data exchange still needs an implementation.
Your technical team or service provider builds and tests the exchange against the documented endpoints.