Home Explore Help
Sign In
cturan
/
vendure
mirror of https://github.com/vendure-ecommerce/vendure
1
0
Fork 0
Files Issues 0 Wiki
Tree: 8e61fc4f1e
Branches Tags
vendure
/
docs
/
docs
/
reference
/
index.mdx

index.mdx 808 B
History Raw

12345678910111213141516171819202122232425262728 
  1. ---
    2. 

  2. title: "Vendure API Reference"
    3. 

  3. ---
    4. 

  4. 

  5. This section contains reference documentation for the various APIs exposed by Vendure.
    6. 

  6. 

  7. :::info
    8. 

  8. All of the information in this section is generated directly from the Vendure source code. You can jump directly
    9. 

  9. to the source file using the links below each heading.
    10. 

  10. 

  11. ![Source links](./links.webp)
    12. 

  12. :::
    13. 

  13. 

  14. ### TypeScript API
    15. 

  15. 

  16. These are the classes, interfaces and other TypeScript object which are used when **writing plugins** or custom business logic.
    17. 

  17. 

  18. ### Core Plugins
    19. 

  19. 

  20. These are the TypeScript APIs for the core Vendure plugins.
    21. 

  21. 

  22. ### GraphQL API
    23. 

  23. 

  24. These are the GraphQL APIs you will use to build your storefront (Shop API) or admin integrations (Admin API).
    25. 

  25. 

  26. ### Admin UI API
    27. 

  27. 

  28. These are the Angular components and services you can use when building Admin UI extensions.
    29.