Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/ship
--data-raw '{
"items": [
{
"id": "id_uHIzYcTxCHG",
"quantity": 3083340957614080
"id": "id_LNI7MlaiSujsAR",
"quantity": 216057904103424
}
],
"metadata": {}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
curl '{backend_url}/admin/orders/{id}/preview' \
-H 'x-medusa-access-token: {api_token}'
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
curl -X POST '{backend_url}/admin/returns/{id}/request-items' \
-H 'x-medusa-access-token: {api_token}'
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
curl -X DELETE '{backend_url}/admin/returns/{id}/request-items/{action_id}' \
-H 'x-medusa-access-token: {api_token}'
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
curl -X POST '{backend_url}/admin/returns/{id}/request-items/{action_id}' \
-H 'x-medusa-access-token: {api_token}'
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
curl -X POST '{backend_url}/admin/returns/{id}/request' \
-H 'x-medusa-access-token: {api_token}'
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
curl -X POST '{backend_url}/admin/returns/{id}/shipping-method' \
-H 'x-medusa-access-token: {api_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"shipping_option_id": "{value}"
}'
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
curl -X DELETE '{backend_url}/admin/returns/{id}/shipping-method/{action_id}' \
-H 'x-medusa-access-token: {api_token}'
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
curl -X POST '{backend_url}/admin/returns/{id}/shipping-method/{action_id}' \
-H 'x-medusa-access-token: {api_token}'
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
type: object
description: SUMMARY
x-schemaName: AdminPostReturnsConfirmRequestReqSchema
properties:
no_notification:
type: boolean
title: no_notification
description: The return's no notification.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ properties:
type: string
title: order_id
description: The return's order id.
location_id:
type: string
title: location_id
description: The return's location id.
description:
type: string
title: description
Expand All @@ -17,6 +21,10 @@ properties:
type: string
title: internal_note
description: The return's internal note.
no_notification:
type: boolean
title: no_notification
description: The return's no notification.
metadata:
type: object
description: The return's metadata.
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
type: object
description: SUMMARY
x-schemaName: AdminPostReturnsRequestItemsActionReqSchema
properties:
quantity:
type: number
title: quantity
description: The return's quantity.
internal_note:
type: string
title: internal_note
description: The return's internal note.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
type: object
description: SUMMARY
x-schemaName: AdminPostReturnsRequestItemsReqSchema
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.
metadata:
type: object
description: The item's metadata.
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
type: object
description: SUMMARY
x-schemaName: AdminPostReturnsShippingActionReqSchema
properties:
custom_price:
type: number
title: custom_price
description: The return's custom price.
internal_note:
type: string
title: internal_note
description: The return's internal note.
metadata:
type: object
description: The return's metadata.
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
type: object
description: SUMMARY
x-schemaName: AdminPostReturnsShippingReqSchema
required:
- shipping_option_id
properties:
shipping_option_id:
type: string
title: shipping_option_id
description: The return's shipping option id.
custom_price:
type: number
title: custom_price
description: The return's custom price.
description:
type: string
title: description
description: The return's description.
internal_note:
type: string
title: internal_note
description: The return's internal note.
metadata:
type: object
description: The return's metadata.
Loading