Documentation

Ship OAuth and access control flows confidently

Browse guides for the Developer Portal, account linking, credential requests, and scope management in one place.

Overview
Key references and diagrams.

Platform goals, personas, and architecture references.

Open section →
Getting Started
Key references and diagrams.
Authentication
Key references and diagrams.

OAuth 2.0 flow, token exchange, and scopes policy.

Open section →

1. General Overview

Welcome to the API documentation

This comprehensive guide will help you integrate with our API efficiently and effectively.

1.1 Purpose

The Amaze Open API enables developers, sellers, and partners to seamlessly integrate with the Amaze Core Platform. It provides programmatic access to shop operations, product management, order processing, and logistics automation.

This documentation outlines how to connect, authenticate, and use the available APIs to build efficient solutions that integrate with Amaze Shop, Seller Center, and Admin Portal.

1.2 Amaze Platform

Core Amaze consist of:

Shop

the front-end sales channel where customers place orders.

Seller Center

the merchant portal for managing products, promotions, and orders.

Admin Portal

the platform management backend for administrators and Amaze team.

Integration consist of:

Integration Layer (API Gateway)

the bridge connecting Amaze with external systems such as ERPs, OMS, or third-party logistics.

ZORT Integration

supports synchronization of stock, order, and settlement data between Amaze and ZORT system.

1.3 Data Flow Overview

Typical process flow between systems:

  1. Seller connects their system via API key and token.
  2. Product catalog is synchronized from Seller Center to Amaze.
  3. Orders are received and processed via API.
  4. Waybill and logistics updates are pushed to Amaze.
  5. Settlement and invoice data are retrieved for financial reconciliation.