DEVELOPER DOCUMENTATION
Start with a business task
Choose one commerce workflow and establish a safe integration environment before writing changes.
Define the outcome#
Start with a merchant task: inspect a catalogue, reconcile a stock update or follow an order. Identify the relevant business owner and the records that need to be read or changed.
Obtain environment access#
Ask the Agora team for the correct API origin, tenant, authentication requirements and access scope. A tenant identifier selects business context; it is not proof that a caller is authorised.
Begin with a read#
The supplied OpenAPI contract documents GET /products and GET /orders. Start with a read-only request in the agreed environment, inspect the result and confirm pagination and data ownership before implementing writes.
Validate before production#
Test missing access, invalid identifiers, provider failures and repeated delivery where relevant. Document the actual contract version used for acceptance.
# Read-only example. Add the authentication required by your environment.
# AGORA_API_ORIGIN is the origin supplied for your deployment.
curl --get "$AGORA_API_ORIGIN/v1/products" \
--header "X-Tenant-Id: $AGORA_TENANT_ID" \
--data-urlencode "filter[status]=published" \
--data-urlencode "sort=-updated_at"Derived from the supplied API contract; not executed against a live tenant. The response shape and authentication must match your environment.