Files
medusa-store/www/docs/content/modules/orders/overview.mdx
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

344 lines
8.8 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
description: "Customers place orders to purchase products from an ecommerce business. Learn about the available features and guides."
---
import DocCardList from '@theme/DocCardList';
import Icons from '@theme/Icon';
# Orders
Customers place orders to purchase products from an ecommerce business. This overview introduces the available features related to orders.
:::note
Not a developer? Check out the [Orders user guide](../../user-guide/orders/index.md).
:::
## Features
### Order Management
Admins can manage orders placed by customers, including capturing payment and fulfilling items in the order. Admins can also export orders into CSV files.
Customers can view their previous orders.
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/modules/orders/admin/manage-orders',
label: 'Admin: Manage Orders',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to manage orders using Admin APIs.',
}
},
{
type: 'link',
href: '/user-guide/orders/manage',
label: 'User Guide: Manage Orders',
customProps: {
icon: Icons['users-solid'],
description: 'Manage orders in Medusa Admin.'
}
},
{
type: 'link',
href: '/user-guide/orders/export',
label: 'User Guide: Export Orders',
customProps: {
icon: Icons['users-solid'],
description: 'Export orders into CSV files in Medusa admin.'
}
},
]} />
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/user-guide/orders/payments',
label: 'User Guide: Manage Payments',
customProps: {
icon: Icons['users-solid'],
description: 'Manage an order\'s payment in Medusa Admin.'
}
},
{
type: 'link',
href: '/user-guide/orders/fulfillments',
label: 'User Guide: Manage Fulfillment',
customProps: {
icon: Icons['users-solid'],
description: 'Manage an order\'s fulfillment in Medusa Admin.'
}
},
{
type: 'link',
href: '/modules/orders/storefront/retrieve-order-details',
label: 'Storefront: Retrieve Order Details',
customProps: {
icon: Icons['academic-cap-solid'],
description: "Learn the different ways to retrieve an order's details",
}
},
]} />
### Edit Orders
Admins can perform edits on items in an order, such as add, remove, or update items. Admins can request confirmation from the customer or force apply the edit.
Customers can review order edit requests and authorize additional payments if necessary.
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/modules/orders/admin/edit-order',
label: 'Admin: Edit an Order',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to edit an order using Admin APIs.'
}
},
{
type: 'link',
href: '/user-guide/orders/edit',
label: 'User Guide: Edit Order',
customProps: {
icon: Icons['users-solid'],
description: 'Edit an order in Medusa Admin.'
}
},
{
type: 'link',
href: '/modules/orders/storefront/handle-order-edits',
label: 'Storefront: Order Edits',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Handle order edits in a storefront.'
}
},
]} />
### Draft Orders
Admins can create draft orders that dont require involvement from a customer. They can specify all details including items in the order, payment method, and more.
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/modules/orders/admin/manage-draft-orders',
label: 'Admin: Manage Draft Orders',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to manage draft orders using Admin APIs.',
}
},
{
type: 'link',
href: '/user-guide/orders/edit',
label: 'User Guide: Draft Orders',
customProps: {
icon: Icons['users-solid'],
description: 'Manage draft orders in Medusa Admin.'
}
},
{
type: 'link',
href: 'https://docs.medusajs.com/api/admin#draft-orders_getdraftorders',
label: 'Admin APIs: Draft Orders',
customProps: {
icon: Icons['server-solid'],
description: 'Check available Admin REST APIs for Draft Orders.'
}
},
]} />
### Returns, Swaps, and Claims
Admins can return order items, or create swaps to return an item to be replaced by a new one.
Customers can also request to return or swap items. This allows for implementing an automated Return Merchandise Authorization (RMA) flow.
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/modules/orders/admin/manage-returns',
label: 'Admin: Manage Returns',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to manage returns using Admin APIs.',
}
},
{
type: 'link',
href: '/modules/orders/admin/manage-swaps',
label: 'Admin: Manage Swaps',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to manage swaps using Admin APIs.',
}
},
{
type: 'link',
href: '/modules/orders/admin/manage-claims',
label: 'Admin: Manage Claims',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to manage claims using Admin APIs.',
}
},
{
type: 'link',
href: '/user-guide/orders/returns',
label: 'User Guide: Manage Returns',
customProps: {
icon: Icons['users-solid'],
description: 'Manage order returns in Medusa Admin.'
}
},
{
type: 'link',
href: '/user-guide/orders/exchange',
label: 'User Guide: Exchanges',
customProps: {
icon: Icons['users-solid'],
description: 'Manage order exchanges in Medusa Admin.'
}
},
{
type: 'link',
href: '/user-guide/orders/claims',
label: 'User Guide: Manage Claims',
customProps: {
icon: Icons['users-solid'],
description: 'Manage order claims in Medusa Admin.'
}
},
{
type: 'link',
href: '/modules/orders/storefront/create-return',
label: 'Storefront: Create a Return',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to create a return as a customer.',
}
},
{
type: 'link',
href: '/modules/orders/storefront/create-swap',
label: 'Storefront: Create a Swap',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to create a swap as a customer.',
}
},
{
type: 'link',
href: 'https://docs.medusajs.com/api/store#returns',
label: 'Storefront APIs: Returns',
customProps: {
icon: Icons['server-solid'],
description: 'Check available Storefront REST APIs for Returns.'
}
},
]} />
---
## Understand the Architecture
Learn how order-related entities are built, their relation to other modules, and more.
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/modules/orders',
label: 'Architecture: Order',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Learn about the Order architecture.',
}
},
{
type: 'link',
href: '/modules/orders/swaps',
label: 'Architecture: Swap',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Learn about the Swap architecture.',
}
},
{
type: 'link',
href: '/modules/orders/returns',
label: 'Architecture: Return',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Learn about the Return architecture.',
}
},
{
type: 'link',
href: '/modules/orders/claims',
label: 'Architecture: Claim',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Learn about the Claim architecture.',
}
},
{
type: 'link',
href: '/modules/orders/draft-orders',
label: 'Architecture: Draft Order',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Learn about the Draft Order architecture.',
}
},
{
type: 'link',
href: '/modules/orders/fulfillments',
label: 'Architecture: Fulfillment',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Learn about the Fulfillment architecture.',
}
},
]} />
---
## Related Modules
Discover Orders relation to other modules in Medusa
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/modules/carts-and-checkout/overview',
label: 'Carts and Checkout',
customProps: {
icon: Icons['shopping-cart-solid'],
description: 'Customers can place an order using a virtual cart.'
}
},
{
type: 'link',
href: '/modules/products/overview',
label: 'Products',
customProps: {
icon: Icons['tag-solid'],
description: 'Customers can browse products to purchase them.'
}
},
{
type: 'link',
href: '/modules/sales-channels/overview',
label: 'Sales Channels',
customProps: {
icon: Icons['channels-solid'],
description: 'Orders can be associated with specific channels.',
}
},
]} />