Files
medusa-store/www/docs/content/references/entities/index.md
Shahed Nasser 914d773d3a api-ref: custom API reference (#4770)
* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
2023-08-15 18:07:54 +03:00

114 lines
4.6 KiB
Markdown

---
displayed_sidebar: entitiesSidebar
---
# Entities Reference
## Enumerations
- [AllocationType](enums/AllocationType.md)
- [CartType](enums/CartType.md)
- [ClaimFulfillmentStatus](enums/ClaimFulfillmentStatus.md)
- [ClaimPaymentStatus](enums/ClaimPaymentStatus.md)
- [ClaimReason](enums/ClaimReason.md)
- [ClaimType](enums/ClaimType.md)
- [DiscountConditionOperator](enums/DiscountConditionOperator.md)
- [DiscountConditionType](enums/DiscountConditionType.md)
- [DiscountRuleType](enums/DiscountRuleType.md)
- [DraftOrderStatus](enums/DraftOrderStatus.md)
- [FulfillmentStatus](enums/FulfillmentStatus.md)
- [OrderEditItemChangeType](enums/OrderEditItemChangeType.md)
- [OrderEditStatus](enums/OrderEditStatus.md)
- [OrderStatus](enums/OrderStatus.md)
- [PaymentCollectionStatus](enums/PaymentCollectionStatus.md)
- [PaymentCollectionType](enums/PaymentCollectionType.md)
- [PaymentSessionStatus](enums/PaymentSessionStatus.md)
- [PaymentStatus](enums/PaymentStatus.md)
- [ProductStatus](enums/ProductStatus.md)
- [RefundReason](enums/RefundReason.md)
- [RequirementType](enums/RequirementType.md)
- [ReturnStatus](enums/ReturnStatus.md)
- [ShippingOptionPriceType](enums/ShippingOptionPriceType.md)
- [ShippingProfileType](enums/ShippingProfileType.md)
- [SwapFulfillmentStatus](enums/SwapFulfillmentStatus.md)
- [SwapPaymentStatus](enums/SwapPaymentStatus.md)
- [UserRoles](enums/UserRoles.md)
## Classes
- [Address](classes/Address.md)
- [AnalyticsConfig](classes/AnalyticsConfig.md)
- [BatchJob](classes/BatchJob.md)
- [Cart](classes/Cart.md)
- [ClaimImage](classes/ClaimImage.md)
- [ClaimItem](classes/ClaimItem.md)
- [ClaimOrder](classes/ClaimOrder.md)
- [ClaimTag](classes/ClaimTag.md)
- [Country](classes/Country.md)
- [Currency](classes/Currency.md)
- [CustomShippingOption](classes/CustomShippingOption.md)
- [Customer](classes/Customer.md)
- [CustomerGroup](classes/CustomerGroup.md)
- [Discount](classes/Discount.md)
- [DiscountCondition](classes/DiscountCondition.md)
- [DiscountConditionCustomerGroup](classes/DiscountConditionCustomerGroup.md)
- [DiscountConditionProduct](classes/DiscountConditionProduct.md)
- [DiscountConditionProductCollection](classes/DiscountConditionProductCollection.md)
- [DiscountConditionProductTag](classes/DiscountConditionProductTag.md)
- [DiscountConditionProductType](classes/DiscountConditionProductType.md)
- [DiscountRule](classes/DiscountRule.md)
- [DraftOrder](classes/DraftOrder.md)
- [Fulfillment](classes/Fulfillment.md)
- [FulfillmentItem](classes/FulfillmentItem.md)
- [FulfillmentProvider](classes/FulfillmentProvider.md)
- [GiftCard](classes/GiftCard.md)
- [GiftCardTransaction](classes/GiftCardTransaction.md)
- [IdempotencyKey](classes/IdempotencyKey.md)
- [Image](classes/Image.md)
- [Invite](classes/Invite.md)
- [LineItem](classes/LineItem.md)
- [LineItemAdjustment](classes/LineItemAdjustment.md)
- [LineItemTaxLine](classes/LineItemTaxLine.md)
- [MoneyAmount](classes/MoneyAmount.md)
- [Note](classes/Note.md)
- [Notification](classes/Notification.md)
- [Oauth](classes/Oauth.md)
- [Order](classes/Order.md)
- [OrderEdit](classes/OrderEdit.md)
- [OrderItemChange](classes/OrderItemChange.md)
- [Payment](classes/Payment.md)
- [PaymentCollection](classes/PaymentCollection.md)
- [PaymentProvider](classes/PaymentProvider.md)
- [PaymentSession](classes/PaymentSession.md)
- [PriceList](classes/PriceList.md)
- [Product](classes/Product.md)
- [ProductCollection](classes/ProductCollection.md)
- [ProductOption](classes/ProductOption.md)
- [ProductOptionValue](classes/ProductOptionValue.md)
- [ProductTag](classes/ProductTag.md)
- [ProductTaxRate](classes/ProductTaxRate.md)
- [ProductType](classes/ProductType.md)
- [ProductTypeTaxRate](classes/ProductTypeTaxRate.md)
- [ProductVariant](classes/ProductVariant.md)
- [PublishableApiKey](classes/PublishableApiKey.md)
- [PublishableApiKeySalesChannel](classes/PublishableApiKeySalesChannel.md)
- [Refund](classes/Refund.md)
- [Region](classes/Region.md)
- [Return](classes/Return.md)
- [ReturnItem](classes/ReturnItem.md)
- [ReturnReason](classes/ReturnReason.md)
- [SalesChannel](classes/SalesChannel.md)
- [ShippingMethod](classes/ShippingMethod.md)
- [ShippingMethodTaxLine](classes/ShippingMethodTaxLine.md)
- [ShippingOption](classes/ShippingOption.md)
- [ShippingOptionRequirement](classes/ShippingOptionRequirement.md)
- [ShippingProfile](classes/ShippingProfile.md)
- [ShippingTaxRate](classes/ShippingTaxRate.md)
- [StagedJob](classes/StagedJob.md)
- [Store](classes/Store.md)
- [Swap](classes/Swap.md)
- [TaxProvider](classes/TaxProvider.md)
- [TaxRate](classes/TaxRate.md)
- [TrackingLink](classes/TrackingLink.md)
- [User](classes/User.md)