feat(dashboard): order edit UI (#8700)
**What** - order edit create flow - active order edit panel **Note** - basic implementation of the flow, edge cases from the design such as fulfilled quantities validation will be added in a followup
This commit is contained in:
@@ -13,7 +13,7 @@ import { throwIfOrderIsCancelled } from "../../utils/order-validation"
|
||||
/**
|
||||
* This step validates that an order-edit can be requested for an order.
|
||||
*/
|
||||
export const beginorderEditValidationStep = createStep(
|
||||
export const beginOrderEditValidationStep = createStep(
|
||||
"begin-order-edit-validation",
|
||||
async function ({ order }: { order: OrderDTO }) {
|
||||
throwIfOrderIsCancelled({ order })
|
||||
@@ -37,7 +37,7 @@ export const beginOrderEditOrderWorkflow = createWorkflow(
|
||||
throw_if_key_not_found: true,
|
||||
})
|
||||
|
||||
beginorderEditValidationStep({ order })
|
||||
beginOrderEditValidationStep({ order })
|
||||
|
||||
const orderChangeInput = transform({ input }, ({ input }) => {
|
||||
return {
|
||||
|
||||
@@ -33,6 +33,7 @@ import { TaxRate } from "./tax-rate"
|
||||
import { TaxRegion } from "./tax-region"
|
||||
import { Upload } from "./upload"
|
||||
import { User } from "./user"
|
||||
import { OrderEdit } from "./order-edit"
|
||||
|
||||
export class Admin {
|
||||
public invite: Invite
|
||||
@@ -56,6 +57,7 @@ export class Admin {
|
||||
public inventoryItem: InventoryItem
|
||||
public notification: Notification
|
||||
public order: Order
|
||||
public orderEdit: OrderEdit
|
||||
public return: Return
|
||||
public claim: Claim
|
||||
public exchange: Exchange
|
||||
@@ -92,6 +94,7 @@ export class Admin {
|
||||
this.inventoryItem = new InventoryItem(client)
|
||||
this.notification = new Notification(client)
|
||||
this.order = new Order(client)
|
||||
this.orderEdit = new OrderEdit(client)
|
||||
this.return = new Return(client)
|
||||
this.claim = new Claim(client)
|
||||
this.taxRate = new TaxRate(client)
|
||||
|
||||
@@ -0,0 +1,140 @@
|
||||
import { HttpTypes } from "@medusajs/types"
|
||||
import { Client } from "../client"
|
||||
import { ClientHeaders } from "../types"
|
||||
|
||||
export class OrderEdit {
|
||||
private client: Client
|
||||
constructor(client: Client) {
|
||||
this.client = client
|
||||
}
|
||||
|
||||
async initiateRequest(
|
||||
body: HttpTypes.AdminInitiateOrderEditRequest,
|
||||
query?: HttpTypes.SelectParams,
|
||||
headers?: ClientHeaders
|
||||
) {
|
||||
return await this.client.fetch<HttpTypes.AdminOrderEditPreviewResponse>(
|
||||
`/admin/order-edits`,
|
||||
{
|
||||
method: "POST",
|
||||
headers,
|
||||
body,
|
||||
query,
|
||||
}
|
||||
)
|
||||
}
|
||||
|
||||
async request(
|
||||
id: string,
|
||||
query?: HttpTypes.SelectParams,
|
||||
headers?: ClientHeaders
|
||||
) {
|
||||
return await this.client.fetch<HttpTypes.AdminOrderEditPreviewResponse>(
|
||||
`/admin/order-edits/${id}/request`,
|
||||
{
|
||||
method: "POST",
|
||||
headers,
|
||||
query,
|
||||
}
|
||||
)
|
||||
}
|
||||
|
||||
async confirm(
|
||||
id: string,
|
||||
query?: HttpTypes.SelectParams,
|
||||
headers?: ClientHeaders
|
||||
) {
|
||||
return await this.client.fetch<HttpTypes.AdminOrderEditPreviewResponse>(
|
||||
`/admin/order-edits/${id}/confirm`,
|
||||
{
|
||||
method: "POST",
|
||||
headers,
|
||||
query,
|
||||
}
|
||||
)
|
||||
}
|
||||
|
||||
async cancelRequest(
|
||||
id: string,
|
||||
query?: HttpTypes.SelectParams,
|
||||
headers?: ClientHeaders
|
||||
) {
|
||||
return await this.client.fetch<HttpTypes.AdminOrderEditDeleteResponse>(
|
||||
`/admin/order-edits/${id}`,
|
||||
{
|
||||
method: "DELETE",
|
||||
headers,
|
||||
query,
|
||||
}
|
||||
)
|
||||
}
|
||||
|
||||
async addItems(
|
||||
id: string,
|
||||
body: HttpTypes.AdminAddOrderEditItems,
|
||||
query?: HttpTypes.SelectParams,
|
||||
headers?: ClientHeaders
|
||||
) {
|
||||
return await this.client.fetch<HttpTypes.AdminOrderEditPreviewResponse>(
|
||||
`/admin/order-edits/${id}/items`,
|
||||
{
|
||||
method: "POST",
|
||||
headers,
|
||||
body,
|
||||
query,
|
||||
}
|
||||
)
|
||||
}
|
||||
|
||||
async updateOriginalItem(
|
||||
id: string,
|
||||
itemId: string,
|
||||
body: HttpTypes.AdminUpdateOrderEditItem,
|
||||
query?: HttpTypes.SelectParams,
|
||||
headers?: ClientHeaders
|
||||
) {
|
||||
return await this.client.fetch<HttpTypes.AdminOrderEditPreviewResponse>(
|
||||
`/admin/order-edits/${id}/items/item/${itemId}`,
|
||||
{
|
||||
method: "POST",
|
||||
headers,
|
||||
body,
|
||||
query,
|
||||
}
|
||||
)
|
||||
}
|
||||
|
||||
async updateAddedItem(
|
||||
id: string,
|
||||
actionId: string,
|
||||
body: HttpTypes.AdminUpdateOrderEditItem,
|
||||
query?: HttpTypes.SelectParams,
|
||||
headers?: ClientHeaders
|
||||
) {
|
||||
return await this.client.fetch<HttpTypes.AdminOrderEditPreviewResponse>(
|
||||
`/admin/order-edits/${id}/items/${actionId}`,
|
||||
{
|
||||
method: "POST",
|
||||
headers,
|
||||
body,
|
||||
query,
|
||||
}
|
||||
)
|
||||
}
|
||||
|
||||
async removeAddedItem(
|
||||
id: string,
|
||||
actionId: string,
|
||||
query?: HttpTypes.SelectParams,
|
||||
headers?: ClientHeaders
|
||||
) {
|
||||
return await this.client.fetch<HttpTypes.AdminOrderEditPreviewResponse>(
|
||||
`/admin/order-edits/${id}/items/${actionId}`,
|
||||
{
|
||||
method: "DELETE",
|
||||
headers,
|
||||
query,
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -23,7 +23,11 @@ export class Order {
|
||||
)
|
||||
}
|
||||
|
||||
async retrievePreview(id: string, headers?: ClientHeaders) {
|
||||
async retrievePreview(
|
||||
id: string,
|
||||
query?: SelectParams,
|
||||
headers?: ClientHeaders
|
||||
) {
|
||||
return await this.client.fetch<HttpTypes.AdminOrderPreviewResponse>(
|
||||
`/admin/orders/${id}/preview`,
|
||||
{
|
||||
|
||||
@@ -1 +1,2 @@
|
||||
export * from "./responses"
|
||||
export * from "./payloads"
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
export interface AdminInitiateOrderEditRequest {
|
||||
order_id: string
|
||||
description?: string
|
||||
internal_note?: string
|
||||
metadata?: Record<string, unknown>
|
||||
}
|
||||
|
||||
export interface AdminAddOrderEditItems {
|
||||
items: {
|
||||
variant_id: string
|
||||
quantity: number
|
||||
unit_price?: number
|
||||
internal_note?: string
|
||||
allow_backorder?: boolean
|
||||
metadata?: Record<string, unknown>
|
||||
}[]
|
||||
}
|
||||
|
||||
export interface AdminUpdateOrderEditItem {
|
||||
quantity?: number
|
||||
internal_note?: string | null
|
||||
}
|
||||
@@ -7,3 +7,9 @@ export interface AdminOrderEditPreviewResponse {
|
||||
export interface AdminOrderEditResponse {
|
||||
order_change: OrderChangeDTO
|
||||
}
|
||||
|
||||
export interface AdminOrderEditDeleteResponse {
|
||||
id: string
|
||||
object: "order-edit"
|
||||
deleted: true
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user