API reference

Docs versionv1.2.87·Source 8d546e4Version notes →

Generated from the local OpenAPI snapshot, Go HTTP routes, and JSON tags. Read Conventions first. Supply integrations must also read the current limitations.

Descriptions translate source annotations, with reviewed corrections where noted. A defined field is not proof of implementation in every state, and generated pages do not replace integration testing.

Supply API

10 operations.

Module	Operations
Supply API	10

Storefront API

74 operations.

Module	Operations
Affiliate	3
Content	4
Captcha	1
Cart	4
Catalog	3
Site configuration	2
Coupon	3
Delivery	2
Order	5
License	3
Lottery	6
Media	1
Member Level	2
Notification	3
Review	2
Payment	3
Supplier	7
Ticket	6
Member authentication	8
Wallet	6

Admin API

259 operations.

Module	Operations
Administrators	7
Dashboard	9
Audit	5
Admin authentication	12
Roles & permissions	7
Catalog	43
Content	13
Coupon	11
Currency	4
Fulfillment	4
Install	3
Inventory	9
License	3
Lottery	9
Media	11
Member Level	6
Notify	10
Order	4
Payment	11
Procurement	4
Reseller	10
Settings	9
Downstream accounts	14
Upstream suppliers	17
Ticket	5
Update	4
Members	5
Wallet	10