chore(docs): Updated API Reference (v2) (#8208)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
1 parent
9173dd4f5d
commit
c99cb5c0ca
60 files changed
+3835
-196
No files matched your search
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* @schema AdminExportProductRequest
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminExportProductRequest
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
/**
|
||||
* @schema AdminExportProductResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminExportProductResponse
|
||||
* required:
|
||||
* - workflow_id
|
||||
* properties:
|
||||
* workflow_id:
|
||||
* type: string
|
||||
* title: workflow_id
|
||||
* description: The product's workflow id.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @schema AdminPostCancelReturnReqSchema
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -4,45 +4,19 @@
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
/**
|
||||
* @schema AdminPostReturnsDismissItemsActionReqSchema
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
/**
|
||||
* @schema AdminPostReturnsReceiveItemsActionReqSchema
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
/**
|
||||
* @schema AdminPostReturnsReceiveItemsReqSchema
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
Reference in new issue
Block a user