Skip to main content
- Endpoint reference

API endpoint reference

These are the customer-facing endpoints in the first API version. All paths are relative to https://<app-host>/api/v1.

Last updated - June 5, 2026 Read time - 8 min Author -

Assets

MethodPathPurpose
POST/assetsImport a remote URL as an asset.
POST/assets/uploadsBegin a direct upload.
POST/assets/uploads/{uploadId}/completeFinalize a direct upload.
GET/assetsList assets.
GET/PATCH/DELETE/assets/{id}Read, update, or delete an asset.

Categories, mappings, packs, and tags

MethodPathPurpose
GET/POST/categoriesList or create flat categories.
GET/PATCH/DELETE/categories/{id}Read, rename, or delete a category.
GET/POST/mappingsList or upsert Shopify product mappings.
GET/PUT/DELETE/mappings/{id}Read, replace, or delete a mapping.
GET/POST/packsList or create packs.
GET/DELETE/packs/{id}Read or delete a pack.
GET/POST/license-key-tagsList or create license-key tags.

Orders and access

MethodPathPurpose
GET/orders/{shopify_order_id}Read order download status.
GET/POST/orders/{shopify_order_id}/assignmentsList or create product-level assignments.
GET/orders/{shopify_order_id}/assignments/{purchaseId}/download-urlsMint download URLs.
POST/orders/{shopify_order_id}/revokeDisable access.
POST/orders/{shopify_order_id}/restoreRestore access.
POST/orders/{shopify_order_id}/grant-downloadsGrant extra downloads.
POST/orders/{shopify_order_id}/resendResend the delivery email.

The download-urls endpoint returns 422 withdrawal_consent_required when the shop has EU withdrawal-right consent enabled and the order has no consent record yet; download URLs are issued once the customer consents.

The download-urls and resend endpoints return 409 delivery_not_yet_released when the product has a download delivery delay configured and the buyer's files have not unlocked yet. The error.details.release_at value is the ISO 8601 instant they unlock, and the grant-downloads endpoint releases the order early.

Health and status

MethodPathPurpose
GET/healthCheck API availability.
GET/pingCheck authentication.
GET/jobs/{jobId}Read async job status.

API docs

Start here

API quickstart

Ping the API, import an asset, map it to a product, and assign access to an order.

 Reference

Endpoint reference

Review the available endpoints for assets, mappings, orders, access changes, and status.

Was this helpful?

Still stuck? Email admin@alvaapps.com.

Last updated 2026-06-05