asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Updated API Reference (v2) (#8208)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot]
2024-07-22 07:10:08 +00:00
committed by GitHub
parent 9173dd4f5d
commit c99cb5c0ca
60 changed files with 3835 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
www/apps/api-reference/specs/admin/components/schemas/AdminExportProductRequest.yaml Normal file
View File

@@ -0,0 +1,3 @@
type: object
description: SUMMARY
x-schemaName: AdminExportProductRequest

10
www/apps/api-reference/specs/admin/components/schemas/AdminExportProductResponse.yaml Normal file
View File

@@ -0,0 +1,10 @@
type: object
description: SUMMARY
x-schemaName: AdminExportProductResponse
required:
- workflow_id
properties:
workflow_id:
type: string
title: workflow_id
description: The product's workflow id.

18
www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
required:
- return_id
- internal_note
x-schemaName: AdminPostCancelReturnReqSchema
properties:
return_id:
type: string
title: return_id
description: The return's return id.
no_notification:
type: boolean
title: no_notification
description: The return's no notification.
internal_note:
type: string
title: internal_note
description: The return's internal note.

42
www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml
View File

@@ -2,42 +2,16 @@ type: object
description: SUMMARY
x-schemaName: AdminPostReceiveReturnsReqSchema
required:
- return_id
- items
- internal_note
- metadata
properties:
return_id:
type: string
title: return_id
description: The return's return id.
items:
type: array
description: The return's items.
items:
type: object
description: The item's items.
required:
- id
- quantity
- reason_id
properties:
id:
type: string
title: id
description: The item's ID.
quantity:
type: number
title: quantity
description: The item's quantity.
reason_id:
type: string
title: reason_id
description: The item's reason id.
note:
type: string
title: note
description: The item's note.
internal_note:
type: string
title: internal_note
description: The return's internal note.
description:
type: string
title: description
description: The return's description.
metadata:
type: object
description: The return's metadata.

12
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml Normal file
View File

@@ -0,0 +1,12 @@
type: object
description: SUMMARY
x-schemaName: AdminPostReturnsDismissItemsActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The return's quantity.
internal_note:
type: string
title: internal_note
description: The return's internal note.

12
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml Normal file
View File

@@ -0,0 +1,12 @@
type: object
description: SUMMARY
x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The return's quantity.
internal_note:
type: string
title: internal_note
description: The return's internal note.

30
www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml Normal file
View File

@@ -0,0 +1,30 @@
type: object
description: SUMMARY
x-schemaName: AdminPostReturnsReceiveItemsReqSchema
properties:
items:
type: array
description: The return's items.
items:
type: object
description: The item's items.
required:
- id
- quantity
properties:
id:
type: string
title: id
description: The item's ID.
quantity:
type: number
title: quantity
description: The item's quantity.
description:
type: string
title: description
description: The item's description.
internal_note:
type: string
title: internal_note
description: The item's internal note.