diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/get.sh index 68bfdf36e8..3b39217dab 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/api-keys' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/post.sh index 178e43fe8f..36e272b374 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/api-keys' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/delete.sh index c95d01f896..3de44ec7c5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/api-keys/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/get.sh index bcac6026ff..68358d2d27 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/api-keys/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/post.sh index 2045a6e651..2d71029a57 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/api-keys/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_revoke/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_revoke/post.sh index 0160b92843..b2360f1a04 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_revoke/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_revoke/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/api-keys/{id}/revoke' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_sales-channels/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_sales-channels/post.sh index efa7320559..9119d34aeb 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_sales-channels/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_sales-channels/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/api-keys/{id}/sales-channels' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/get.sh index 9622cad58c..56d2de03ea 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/campaigns' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/post.sh index 542e982cdf..acbfba1886 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/campaigns' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Gunner", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/delete.sh index e4c08c3ef5..3ebb737334 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/campaigns/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/get.sh index a6de1103c9..fc4b8406cd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/campaigns/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/post.sh index f4c15bbb53..7eb06ca3f9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/campaigns/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "description": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}_promotions/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}_promotions/post.sh index a796a09e0b..0d419e244d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}_promotions/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}_promotions/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/campaigns/{id}/promotions' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/get.sh index 6683f812b3..f5f50f469f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/claims' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/post.sh index d8aa41e7d0..a3aea52bf0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/claims' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "type": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}/get.sh index 1c3dd7f2c6..a7a6cfda6b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/claims/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_cancel/post.sh index 95c137725c..3226829fa2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_cancel/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_cancel/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/claims/{id}/cancel' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items/post.sh index 8d76cfe217..865699ff5a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/claims/{id}/claim-items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/delete.sh index 79240df0eb..fddadc0853 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/claims/{id}/claim-items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/post.sh index a2051000ca..c1eeda723f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/claims/{id}/claim-items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items/post.sh index 95ff587f1e..2cc3db7d0d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/claims/{id}/inbound/items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh index 8f3ceaa879..d6f0901e31 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/post.sh index d3dff4cebc..020bb205a9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method/post.sh index 6345f0d29d..150b43469f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/claims/{id}/inbound/shipping-method' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh index 37d6f9e1d7..72f02dc513 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/post.sh index 6d79981f2f..ee6390c509 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items/post.sh index 16f0629acf..d014a67923 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/claims/{id}/outbound/items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh index f75dcd4918..1f157ae0b2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/post.sh index fc55d448af..b22269af1a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method/post.sh index cd206e6943..127622f079 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/claims/{id}/outbound/shipping-method' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh index 500c6f14f5..c2badf8c00 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/post.sh index 488980e9e2..51c09010d5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_request/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_request/delete.sh index 3282b66ffd..a1df03a61f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_request/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_request/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/claims/{id}/request' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_request/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_request/post.sh index 03484b1c9c..d77433ce53 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_request/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_request/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/claims/{id}/request' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/get.sh index ad6a8611a1..9430a07053 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/collections' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/post.sh index 8e19534d37..517d7399e9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/collections' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/delete.sh index ac6ab81926..e94af8ae0b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/collections/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/get.sh index d5e3ac9901..f791ea8cae 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/collections/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/post.sh index 5062552418..2a1cc880a2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/collections/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}_products/post.sh index ecff92ca27..8ec5447e4d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}_products/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}_products/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/collections/{id}/products' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_currencies/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_currencies/get.sh index 98bde5a28f..16866cb27c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_currencies/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_currencies/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/currencies' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_currencies_{code}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_currencies_{code}/get.sh index 1f19a068f4..bd23d94596 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_currencies_{code}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_currencies_{code}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/currencies/{code}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/get.sh index a1e09a1830..e9b7dc2e07 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/customer-groups' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/post.sh index 79c63c6854..10d4b00f67 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/customer-groups' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Solon", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/delete.sh index fb76fec5a4..0e94e178e1 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/customer-groups/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/get.sh index 775aa665b6..1b656c2943 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/customer-groups/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/post.sh index 936f9393fc..fa3b36494e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/customer-groups/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Corbin", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers/post.sh index 8140c7a194..78304ed6fd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/customer-groups/{id}/customers' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/get.sh index a3cb447f4d..330b606a0b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/customers' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/post.sh index 815a3c4f15..4c22188ef7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/customers' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "email": "Tomas.Toy16@yahoo.com", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/delete.sh index 2512d14e1c..f888f2e4a9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/customers/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/get.sh index 84b7af171c..ea23830c88 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/customers/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/post.sh index 20ef2e9c61..03616f6aa0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/customers/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "email": "Daren_Rodriguez-Rutherford93@gmail.com", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/get.sh index f104dfe34d..7348636d1d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/customers/{id}/addresses' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh index ebac8c6489..e6e0230bf5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/customers/{id}/addresses' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "address_name": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/delete.sh index d5cfe4f60e..3fcd54277e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/get.sh index eb76e9ded8..7808f9ce1a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/post.sh index 25b406b1c6..d9b290a82d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "address_name": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/get.sh index a9da54ffd5..8e18aebd95 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/draft-orders' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/post.sh index 86761070d9..331257f098 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/draft-orders' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "sales_channel_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/get.sh index 7427f5b2ce..8deb01bfe4 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/draft-orders/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/get.sh index 801c8a9893..ed36cdaade 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/exchanges' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/post.sh index 14651ebe9b..ea0cd2c78f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/exchanges' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}/get.sh index 4d7144d71d..f0ef181320 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/exchanges/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_cancel/post.sh index 3297293f06..280b6a80e5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_cancel/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_cancel/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/exchanges/{id}/cancel' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items/post.sh index 2fede41df1..8ad0290a3e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh index 9d54eda76b..d93a9ee93b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/post.sh index 63f7ef8236..0397415238 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method/post.sh index 9d948d33d0..3d899ef675 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh index eb403de701..99d50866b9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.sh index 1a05d7a98a..2b98663c65 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items/post.sh index f96acaa8e4..ce78349083 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh index c960008db5..995f1a529c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/post.sh index 404fa4651a..1c7ebee29e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method/post.sh index 401d4df26f..28aaf7fb5a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh index 3bd9fbbe29..591770bd84 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'\ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'\ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.sh index 2f416713ef..20f4ebf586 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/delete.sh index ee18c94a42..2f8d9defa4 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/exchanges/{id}/request' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/post.sh index 1f917cbada..5353c9ef5b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/exchanges/{id}/request' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers/get.sh index daf5cd737d..84c26b0d8e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/fulfillment-providers' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}/delete.sh index 4a2da2a97c..8aa70a0535 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones/post.sh index 309af7936c..a588488101 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Layla" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh index b2c98a2987..03291c47ac 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/get.sh index a0dbeae380..1130539d7c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/post.sh index 3b14a475d3..c161d82deb 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Elvis" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh index 9ce5d4f64e..1f12b18d9b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/fulfillments' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "location_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_cancel/post.sh index c2381712e0..7b5b8fad96 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_cancel/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_cancel/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/fulfillments/{id}/cancel' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_shipment/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_shipment/post.sh index 5fdaaa229a..a401b3488b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_shipment/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_shipment/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/fulfillments/{id}/shipment' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "labels": [ diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/get.sh index 474b73d170..06848aece2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/inventory-items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/post.sh index 444f73740c..de9500d53c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/inventory-items' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "sku": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/delete.sh index 1361e6d32f..00044bc885 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/inventory-items/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/get.sh index ec7499af1d..28003e63c2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/inventory-items/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/post.sh index ca9c2d104a..ecf765cd54 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/inventory-items/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "sku": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/get.sh index 166c163b4b..a073b7d03e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/inventory-items/{id}/location-levels' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh index ae4e9e9072..cdea871212 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "location_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_batch/post.sh index 8480742b65..2914509e54 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_batch/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_batch/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels/batch' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh index a30ae85ec0..d40f31f0b2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh @@ -1 +1 @@ -curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ -H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/post.sh index 1487c477f9..e8c155c88b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications/get.sh index 8cb8da2cbd..232eee5772 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/notifications' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications_{id}/get.sh index 4696e5e151..dea2fb7c82 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_notifications_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/notifications/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits/post.sh index eec0749c3a..09da1eff1a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/order-edits' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}/delete.sh index ed511894ba..e6b0967039 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/order-edits/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_confirm/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_confirm/post.sh index 7ace65c4b0..33b1bb2c07 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_confirm/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_confirm/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/order-edits/{id}/confirm' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items/post.sh index 8c938f2636..141ba073bb 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/order-edits/{id}/items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_item_{item_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_item_{item_id}/post.sh index fae13629c7..61636c0825 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_item_{item_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_item_{item_id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/order-edits/{id}/items/item/{item_id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "quantity": 7564330046324736 diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/delete.sh index 2b3de1670f..28cb5e6db7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/order-edits/{id}/items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/post.sh index fb5e00735f..7402bbce86 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/order-edits/{id}/items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_request/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_request/post.sh index 139f39993f..a2de21e4bc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_request/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_request/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/order-edits/{id}/request' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method/post.sh index 1387c4fcec..957f0c9bb7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/order-edits/{id}/shipping-method' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/delete.sh index c2bdc3a123..ba6ca8e34d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/post.sh index 2d2fd50088..c19b25bc89 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders/get.sh index c35070bfe1..9d2c28a2fe 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/orders' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/get.sh index 362b96e0cb..7bc87142c8 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/orders/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/post.sh index 8cc19fc10d..d3c39b10fd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/orders/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_archive/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_archive/post.sh index 2ca36e9fbd..1b2f6af18c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_archive/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_archive/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/orders/{id}/archive' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_cancel/post.sh index 17db17139d..0e71f31db5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_cancel/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_cancel/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/orders/{id}/cancel' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_changes/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_changes/get.sh index 32787df076..4becebb4fa 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_changes/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_changes/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/orders/{id}/changes' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_complete/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_complete/post.sh index 0f1a33de13..e0da3690ec 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_complete/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_complete/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/orders/{id}/complete' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments/post.sh index 494797f6ac..006327ac71 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/orders/{id}/fulfillments' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "items": [ diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh index b09f7fdc65..afe0461a31 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/cancel' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments/post.sh index cc61fe71df..6470e44579 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipments' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "items": [ diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_preview/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_preview/get.sh index 02867e7b99..c2f67953a5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_preview/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_preview/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/orders/{id}/preview' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections/post.sh index 875f6770ff..d39f0a763a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/payment-collections' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections_{id}/delete.sh index e0fff40d4e..8cf502c006 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/payment-collections/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections_{id}_mark-as-paid/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections_{id}_mark-as-paid/post.sh index 3454d40913..911fcedcb0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections_{id}_mark-as-paid/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections_{id}_mark-as-paid/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/payment-collections/{id}/mark-as-paid' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments/get.sh index 726c428be3..5ef5879964 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/payments' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_payment-providers/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_payment-providers/get.sh index 7919b77c62..6bd9738dc2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_payment-providers/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_payment-providers/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/payments/payment-providers' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}/get.sh index 3d63a30b19..89281e3ced 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/payments/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}_capture/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}_capture/post.sh index dd1ae194e3..97e20b6e46 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}_capture/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}_capture/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/payments/{id}/capture' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}_refund/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}_refund/post.sh index fc1d105267..62633a7e48 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}_refund/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_{id}_refund/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/payments/{id}/refund' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/get.sh index 912c4350b5..7a65b64616 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/price-lists' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/post.sh index 25b84b2e62..3b94951c34 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/price-lists' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/delete.sh index d1e910883d..624534dc44 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/price-lists/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/get.sh index dd174647af..228e93173d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/price-lists/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/post.sh index bef779f42e..9fabd3351a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/price-lists/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "description": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch/post.sh index 809f6fa0a6..a791344a66 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_products/post.sh index e174727077..6a7023d27f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_products/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_products/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/price-lists/{id}/products' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences/get.sh index c2e4eb14ea..9c61d4cef0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/price-preferences' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences/post.sh index afc3c6569d..e43df370ba 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/price-preferences' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/delete.sh index ed3fcdb6a4..32ebbf2a12 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/price-preferences/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/get.sh index d72766fb11..d00265e1a6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/price-preferences/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/post.sh index 5d160b68b3..6c9e7a34c3 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-preferences_{id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/price-preferences/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/get.sh index 5038056433..d68795c508 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/product-categories' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/post.sh index a08aa11d6f..3f067e5faf 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/product-categories' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Vesta", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/delete.sh index 7fb8699c8e..6f12c35b8e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/product-categories/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/get.sh index 908035d8d6..2541b02a4b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/product-categories/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/post.sh index e4cabadb8e..78619bb882 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/product-categories/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "parent_category_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}_products/post.sh index cfd6a809fe..fc57989bc3 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}_products/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}_products/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/product-categories/{id}/products' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/get.sh index c1996a927e..82e33221f3 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/product-tags' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/post.sh index c7f0793cf6..18d92c40fc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/product-tags' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "value": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/delete.sh index 76b3823164..c34ffeb152 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/product-tags/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/get.sh index 2d5beef1ef..ff8f34d73a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/product-tags/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/post.sh index 0e85df080f..9de2ffcc23 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/product-tags/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/get.sh index 298ba1bc80..7663287a49 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/product-types' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/post.sh index 6dae543255..a173555a63 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/product-types' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "value": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/delete.sh index 41d85b9231..2dbcd90e62 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/product-types/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/get.sh index 86eb0e7fe7..e809c3788a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/product-types/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/post.sh index 8be86c10fc..277f9ce301 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/product-types/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-variants/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-variants/get.sh index 885315611f..10ea2dbc20 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-variants/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-variants/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/product-variants' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/get.sh index f7b343e7bc..c814a854ff 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/products' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh index c0ddca6119..f1779653af 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/products' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_batch/post.sh index 81ba8a99f3..0475aa1407 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_batch/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_batch/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/batch' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_export/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_export/post.sh index 342d49a687..cddf5dd676 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_export/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_export/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/export' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_import/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_import/post.sh index a6221273e6..1d29c6eb87 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_import/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_import/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/import' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_import_{transaction_id}_confirm/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_import_{transaction_id}_confirm/post.sh index 980db2cc46..ef93280b33 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_import_{transaction_id}_confirm/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_import_{transaction_id}_confirm/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/import/{transaction_id}/confirm' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/delete.sh index 1f5383aa7a..2ad9c17ff4 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/products/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/get.sh index ca6c6a0a93..0d16b30441 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/products/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/post.sh index 99441e36d4..b6fffdbc5b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/get.sh index bc8e84d5f4..c467cd1c5c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/products/{id}/options' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/post.sh index 50d34ac315..a805c2120f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/products/{id}/options' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/delete.sh index 568d959752..7f005e9a2f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/products/{id}/options/{option_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/get.sh index d2273061dc..246dbafdcf 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/products/{id}/options/{option_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/post.sh index 1d9e2d5171..e7e3f42fbf 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/{id}/options/{option_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/get.sh index c0dec3e252..8b676118b9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/products/{id}/variants' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/post.sh index 267923fb23..3e97ac7bb3 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/products/{id}/variants' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_batch/post.sh index 331e8986c6..044eb37dd7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_batch/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_batch/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/{id}/variants/batch' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_inventory-items_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_inventory-items_batch/post.sh index 406d104ffc..a1e338bc20 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_inventory-items_batch/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_inventory-items_batch/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/{id}/variants/inventory-items/batch' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/delete.sh index 6ed61d5122..7eb1db3952 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/products/{id}/variants/{variant_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/get.sh index 6b281d3485..9292a6d24e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/products/{id}/variants/{variant_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/post.sh index 56948c9bd9..47e49c976d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items/post.sh index a71b17413a..71bbb4240d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "required_quantity": 7390879820021760, diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/delete.sh index c9297cbe64..e50b65f8dc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/post.sh index 011fc0e4fe..6aa47348aa 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "required_quantity": 5324804697620480 diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/get.sh index 0472aff68a..021543f0fe 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/promotions' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/post.sh index eba2bc3884..a1884bb0c1 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/promotions' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "code": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-attribute-options_{rule_type}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-attribute-options_{rule_type}/get.sh index 4d3c48e6ed..c63e3d1f25 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-attribute-options_{rule_type}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-attribute-options_{rule_type}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/promotions/rule-attribute-options/{rule_type}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}/get.sh index 071bf10e2a..fd382a44b4 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/delete.sh index fa31c2953c..11bc69c8a0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/promotions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/get.sh index ba41beb534..f79ac28668 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/promotions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/post.sh index b1312463d2..d07ea9a573 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/promotions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "campaign_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch/post.sh index 8383761d0d..6e6ba11b8d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch/post.sh index 112e23e54e..7f25397abc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch/post.sh index 9b65005dbb..1f1eb36e19 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_{rule_type}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_{rule_type}/get.sh index 4a85b6172a..8b845fbc57 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_{rule_type}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_{rule_type}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/promotions/{id}/{rule_type}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/get.sh index 085a0267ec..fd533399b1 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/refund-reasons' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/post.sh index 7c561f9022..8f114e78d6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/refund-reasons' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "label": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/delete.sh index 740e330caa..1f2070e22d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/refund-reasons/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/get.sh index 9bbf91892a..cd0361f3df 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/refund-reasons/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/post.sh index 463943c99a..337e73c743 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/refund-reasons/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "description": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/get.sh index d867926ab3..876c144521 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/regions' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/post.sh index bf07c77282..7ba1e5e20d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/regions' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Heloise", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/delete.sh index c1a1e78e1f..f4df34faef 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/regions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/get.sh index abd55fc993..905e627544 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/regions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/post.sh index ac108e991a..54010963fe 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/regions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/get.sh index a2328ea707..bb30390abf 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/reservations' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/post.sh index 1c3bc92b9f..2093865c10 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/reservations' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "line_item_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/delete.sh index 0c8410a3a7..cbbf6f6ea0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/reservations/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/get.sh index 1984cec62e..94e7d056fa 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/reservations/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/post.sh index 565a7c4131..5f4c9e97d5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/reservations/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "description": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/get.sh index 26e49166a3..0194e29f32 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/return-reasons' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/post.sh index 903d197b49..8dffacb054 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/return-reasons' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "value": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/delete.sh index 24ef4616e0..671612ab43 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/return-reasons/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/get.sh index 3693f27785..62fd310e8b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/return-reasons/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/post.sh index 7a36891f75..8d898b65f4 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/return-reasons/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/get.sh index 108c2d6363..6476e88c50 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/returns' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/post.sh index c39886ecb9..26d3e627d2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/returns' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/get.sh index 2cc8ac827d..5dc3986143 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/returns/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/post.sh index 7e040b54a5..64d0748177 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/returns/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_cancel/post.sh index dbc70ff89a..9433d66833 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_cancel/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_cancel/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/returns/{id}/cancel' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items/post.sh index 3f9fa1af6e..5f61877ed6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/delete.sh index daf79d095d..4f3342c33f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/post.sh index f7b1a9a521..43ca062b0e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_dismiss-items_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items/post.sh index 529c435c37..339a529de7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/returns/{id}/receive-items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/delete.sh index 2dd087ed2f..4f08083d8b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/post.sh index 71a5bc5488..93558a4ddd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/delete.sh index 75900a6937..58e35389e8 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/returns/{id}/receive' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/post.sh index f900c629fa..8ee91d1b79 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/returns/{id}/receive' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "return_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive_confirm/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive_confirm/post.sh index f53ae5c12f..6151e2325a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive_confirm/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive_confirm/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/returns/{id}/receive/confirm' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items/post.sh index f466f969df..8f1eb6871f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/returns/{id}/request-items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items_{action_id}/delete.sh index d1e574020c..08cfacc015 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items_{action_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/returns/{id}/request-items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items_{action_id}/post.sh index 6564939a85..e4c363608b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request-items_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/returns/{id}/request-items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request/delete.sh index 01e23a0d18..7fd2fd978e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/returns/{id}/request' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request/post.sh index 9ea1eafc1d..ab1b6b96d8 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_request/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/returns/{id}/request' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method/post.sh index 1c003ae49d..d21782ab96 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/returns/{id}/shipping-method' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method_{action_id}/delete.sh index d8d112c2ee..b01796f35b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method_{action_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/returns/{id}/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method_{action_id}/post.sh index e2b9e8f6ea..fac8480647 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method_{action_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_shipping-method_{action_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/returns/{id}/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/get.sh index 3fb86e9166..2563c94448 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/sales-channels' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/post.sh index 60d046d7d2..de7fa74f7b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/sales-channels' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Linnea", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/delete.sh index 9650bf9aca..c14f46ce4e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/sales-channels/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/get.sh index b28d3e3ad8..3a912e3f0b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/sales-channels/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/post.sh index 8fba95522e..cb2984ecab 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/sales-channels/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "description": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}_products/post.sh index 8867864420..823d2d73a3 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}_products/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}_products/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/sales-channels/{id}/products' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/get.sh index 54954506e0..c0438f6fa9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/shipping-options' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/post.sh index 2b40e026ac..c52c5fac39 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/shipping-options' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Julie", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/delete.sh index 68324bddb5..81863ce193 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/shipping-options/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/post.sh index fb77cb94ce..5cf25cf5a8 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/shipping-options/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}_rules_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}_rules_batch/post.sh index 797474e738..69f4ee8201 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}_rules_batch/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}_rules_batch/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/shipping-options/{id}/rules/batch' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/get.sh index 7609587e4b..6f61271e80 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/shipping-profiles' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/post.sh index b448bcb6ca..34912b586f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/shipping-profiles' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Percy", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/delete.sh index a8cd54c867..21878cd48a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/shipping-profiles/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/get.sh index 7c4bc5043b..e3954ff08e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/shipping-profiles/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/post.sh index 54901b1199..6670f671df 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/shipping-profiles/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/get.sh index f7af7633f4..89df916788 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/stock-locations' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/post.sh index 4f39ebfb13..f28f565b88 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/stock-locations' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Maryam", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/delete.sh index ad7c82955d..6a04862f4b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/stock-locations/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/get.sh index 27fe59d04e..fab9d4c702 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/stock-locations/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/post.sh index 434c74b5b3..7fd9965c53 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/stock-locations/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "address_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-providers/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-providers/post.sh index 7d1cf42f23..d82b3cd2ea 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-providers/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-providers/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/stock-locations/{id}/fulfillment-providers' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-sets/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-sets/post.sh index 239f55fbee..fb2eab389d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-sets/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-sets/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/stock-locations/{id}/fulfillment-sets' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Helene", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_sales-channels/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_sales-channels/post.sh index d66bae0b04..d636c52653 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_sales-channels/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_sales-channels/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/stock-locations/{id}/sales-channels' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores/get.sh index 143cec0092..f383ab2582 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/stores' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/get.sh index dd38b862b1..a0f6e1e593 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/stores/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/post.sh index 63b7f51e17..401cf5d3ea 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/stores/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Melvina", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/get.sh index 7be7a1d650..7fb0a9048c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/tax-rates' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/post.sh index 7250855c52..d98dcb0a55 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/tax-rates' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Kaylin", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/delete.sh index bc3e9c0401..dcf17a2563 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/tax-rates/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/get.sh index cb8de3d3c9..3cf77f27a6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/tax-rates/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/post.sh index f6e7429ba6..d2f4f4955a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/tax-rates/{id}' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}_rules/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}_rules/post.sh index fcf987b588..a974fc782b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}_rules/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}_rules/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/tax-rates/{id}/rules' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "reference": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}_rules_{rule_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}_rules_{rule_id}/delete.sh index b19c33b9da..faa3e9689f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}_rules_{rule_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}_rules_{rule_id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/tax-rates/{id}/rules/{rule_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/get.sh index 429eacab74..ba9893f566 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/tax-regions' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh index 16738887b3..d62db2eeb4 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/tax-regions' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "country_code": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/delete.sh index cb7e9b92f1..4542bec504 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/tax-regions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/get.sh index 59ebcb1e3d..c91bc79151 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/tax-regions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads/post.sh index 84911b72b1..ae7c1a8969 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/uploads' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/delete.sh index 61735226f5..14bdf621f5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/delete.sh @@ -1,2 +1,2 @@ curl -X DELETE '{backend_url}/admin/uploads/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/get.sh index 196d8224ab..4038cecbec 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/uploads/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions/get.sh index c5d17ea5f4..a32739d585 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/workflows-executions' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{id}/get.sh index 723379548d..38d81b088c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/workflows-executions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_run/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_run/post.sh index 51476ae804..f01061dee0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_run/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_run/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/run' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_steps_failure/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_steps_failure/post.sh index 2d92a65259..3502ee6795 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_steps_failure/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_steps_failure/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/steps/failure' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "transaction_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_steps_success/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_steps_success/post.sh index 7bb98bdcf7..9a5b6e5843 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_steps_success/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_steps_success/post.sh @@ -1,5 +1,5 @@ curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/steps/success' \ --H 'x-medusa-access-token: {api_token}' \ +-H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "transaction_id": "{value}", diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_subscribe/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_subscribe/get.sh index 610667dd3c..f1e14c975d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_subscribe/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_subscribe/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/workflows-executions/{workflow_id}/subscribe' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_{transaction_id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_{transaction_id}/get.sh index 4b53944df0..9fc17afd57 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_{transaction_id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_{transaction_id}/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe/get.sh index f669d33759..f6a3845b3b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe/get.sh @@ -1,2 +1,2 @@ curl '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml index d0f0e88f40..f94371d50e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The preview of an order. x-schemaName: AdminOrderPreviewResponse required: - order diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml index 18e28bbc59..7dbac7fa46 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: An order's details. x-schemaName: AdminOrderResponse required: - order diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml index 1fed4284d0..ccc9891c96 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The order return details. x-schemaName: AdminOrderReturnResponse required: - order diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml index 2836394d2e..c03bcea935 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml @@ -12,29 +12,13 @@ properties: title: id description: The payment's ID. amount: - oneOf: - - type: string - title: amount - description: The payment's amount. - - type: number - title: amount - description: The payment's amount. - - type: string - title: amount - description: The payment's amount. - - $ref: ./IBigNumber.yaml + type: number + title: amount + description: The payment's amount. authorized_amount: - oneOf: - - type: string - title: authorized_amount - description: The payment's authorized amount. - - type: number - title: authorized_amount - description: The payment's authorized amount. - - type: string - title: authorized_amount - description: The payment's authorized amount. - - $ref: ./IBigNumber.yaml + type: number + title: authorized_amount + description: The amount authorized of the payment. currency_code: type: string title: currency_code @@ -42,86 +26,65 @@ properties: provider_id: type: string title: provider_id - description: The payment's provider id. + description: The ID of the payment provider used to process this payment. cart_id: type: string title: cart_id - description: The payment's cart id. + description: The ID of the associated cart. order_id: type: string title: order_id - description: The payment's order id. + description: The ID of the associated order. order_edit_id: type: string title: order_edit_id - description: The payment's order edit id. + description: The ID of the associated order edit. customer_id: type: string title: customer_id - description: The payment's customer id. + description: ID of the associated customer. data: type: object - description: The payment's data. + description: The payment's data, useful for processing by the payment provider. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment created_at: type: string format: date-time title: created_at - description: The payment's created at. + description: The date the payment was created. updated_at: type: string format: date-time title: updated_at - description: The payment's updated at. + description: The date the payment was updated. captured_at: - oneOf: - - type: string - title: captured_at - description: The payment's captured at. - - type: string - title: captured_at - description: The payment's captured at. - format: date-time + type: string + format: date-time + title: captured_at + description: The date the payment was captured. canceled_at: - oneOf: - - type: string - title: canceled_at - description: The payment's canceled at. - - type: string - title: canceled_at - description: The payment's canceled at. - format: date-time + type: string + format: date-time + title: canceled_at + description: The date the payment was canceled. captured_amount: - oneOf: - - type: string - title: captured_amount - description: The payment's captured amount. - - type: number - title: captured_amount - description: The payment's captured amount. - - type: string - title: captured_amount - description: The payment's captured amount. - - $ref: ./IBigNumber.yaml + type: number + title: captured_amount + description: The captured amount of the payment. refunded_amount: - oneOf: - - type: string - title: refunded_amount - description: The payment's refunded amount. - - type: number - title: refunded_amount - description: The payment's refunded amount. - - type: string - title: refunded_amount - description: The payment's refunded amount. - - $ref: ./IBigNumber.yaml + type: number + title: captured_amount + description: The refunded amount of the payment. captures: type: array - description: The payment's captures. + description: The details of payment captures. items: $ref: ./BaseCapture.yaml refunds: type: array - description: The payment's refunds. + description: The details of payment refunds. items: $ref: ./BaseRefund.yaml payment_collection: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml index 684b9497bb..c6fa1d3cac 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml @@ -1,5 +1,5 @@ type: object -description: The payment collection's payment collections. +description: The payment collection's details. x-schemaName: AdminPaymentCollection required: - id @@ -20,77 +20,41 @@ properties: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. amount: - oneOf: - - type: string - title: amount - description: The payment collection's amount. - - type: number - title: amount - description: The payment collection's amount. - - type: string - title: amount - description: The payment collection's amount. - - $ref: ./IBigNumber.yaml + type: number + title: amount + description: The total amount to be paid. authorized_amount: - oneOf: - - type: string - title: authorized_amount - description: The payment collection's authorized amount. - - type: number - title: authorized_amount - description: The payment collection's authorized amount. - - type: string - title: authorized_amount - description: The payment collection's authorized amount. - - $ref: ./IBigNumber.yaml + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. captured_amount: - oneOf: - - type: string - title: captured_amount - description: The payment collection's captured amount. - - type: number - title: captured_amount - description: The payment collection's captured amount. - - type: string - title: captured_amount - description: The payment collection's captured amount. - - $ref: ./IBigNumber.yaml + type: number + title: captured_amount + description: The total captured amount of the collection's payments. refunded_amount: - oneOf: - - type: string - title: refunded_amount - description: The payment collection's refunded amount. - - type: number - title: refunded_amount - description: The payment collection's refunded amount. - - type: string - title: refunded_amount - description: The payment collection's refunded amount. - - $ref: ./IBigNumber.yaml + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. completed_at: - oneOf: - - type: string - title: completed_at - description: The payment collection's completed at. - - type: string - title: completed_at - description: The payment collection's completed at. - format: date-time + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -102,7 +66,9 @@ properties: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: >- + The payment provider used to process the collection's payments and + sessions. items: $ref: ./BasePaymentProvider.yaml payment_sessions: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionResponse.yaml index ccbf99b8f1..7c352dc4d7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The payment collection's details. x-schemaName: AdminPaymentCollectionResponse required: - payment_collection diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvider.yaml index 022e34057b..c9d275092e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvider.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvider.yaml @@ -1,3 +1,15 @@ type: object -description: The payment provider's payment providers. +description: The payment provider's details. x-schemaName: AdminPaymentProvider +required: + - is_enabled + - id +properties: + id: + type: string + title: id + description: The payment provider's ID. + is_enabled: + type: boolean + title: is_enabled + description: Whether the payment provider is enabled. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentResponse.yaml index ede86ff43a..294330408b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The payment's details. x-schemaName: AdminPaymentResponse required: - payment diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelClaimReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelClaimReqSchema.yaml index 1d3ef97265..6cc0d7e555 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelClaimReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelClaimReqSchema.yaml @@ -1,8 +1,8 @@ type: object -description: SUMMARY +description: The details of canceling a claim. x-schemaName: AdminPostCancelClaimReqSchema properties: no_notification: type: boolean title: no_notification - description: The claim's no notification. + description: Whether to send the customer a notification about the claim's cancelation. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelExchangeReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelExchangeReqSchema.yaml index b73520094e..23b6e49230 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelExchangeReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelExchangeReqSchema.yaml @@ -1,8 +1,10 @@ type: object -description: SUMMARY +description: The details of canceling an exchange. x-schemaName: AdminPostCancelExchangeReqSchema properties: no_notification: type: boolean title: no_notification - description: The exchange's no notification. + description: >- + Whether to send a notification to the customer about the exchange's + cancelation. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml index 68a86d8abf..08c7afb4bb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml @@ -1,8 +1,10 @@ type: object -description: SUMMARY +description: The details of canceling a return. x-schemaName: AdminPostCancelReturnReqSchema properties: no_notification: type: boolean title: no_notification - description: The return's no notification. + description: >- + Whether to send the customer a notification about the return's + cancelation. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml index bd2b3450cc..d1dfd8929f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The details of the order items to add to the claim. x-schemaName: AdminPostClaimItemsReqSchema properties: items: type: array - description: The claim's items. + description: The item's details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -15,14 +15,14 @@ properties: id: type: string title: id - description: The item's ID. + description: The ID of the order's item. quantity: type: number title: quantity - description: The item's quantity. + description: The quantity of the order's item to add to the claim. reason: type: string - description: The item's reason. + description: The reason the item is claimed. enum: - missing_item - wrong_item @@ -35,4 +35,4 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note that's only viewed by admin users. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml index 58910cdc4f..c9ce264412 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The details of the outbound items to add to the claim. x-schemaName: AdminPostClaimsAddItemsReqSchema properties: items: type: array - description: The claim's items. + description: The outbound item's details. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -15,11 +15,11 @@ properties: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity - description: The item's quantity. + description: The quantity to send to the customer. unit_price: type: number title: unit_price @@ -27,7 +27,7 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml index 6ab38aa512..9ce243d228 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml @@ -1,16 +1,16 @@ type: object -description: SUMMARY +description: The details to update in the item. x-schemaName: AdminPostClaimsItemsActionReqSchema properties: quantity: type: number title: quantity - description: The claim's quantity. + description: The item's quantity. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the return reason associated with the item. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note that's only viewed by admin users. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml index 3741c54e3d..8d6fe6cdad 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The details to update in the shipping method. x-schemaName: AdminPostClaimsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The claim's custom amount. + description: The shipping method's custom amount. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note only viewed by admin users. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml index 395e129bdd..34e2356020 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the shipping method used to ship outbound items. x-schemaName: AdminPostClaimsShippingReqSchema required: - shipping_option_id @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The claim's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The claim's custom amount. + description: Set a custom price for the shipping method. description: type: string title: description - description: The claim's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note only viewed by admin users. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml index 6609955ffd..bc0234b0bd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The details of outbound items. x-schemaName: AdminPostExchangesAddItemsReqSchema properties: items: type: array - description: The exchange's items. + description: The details of outbound items. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -15,7 +15,7 @@ properties: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity @@ -27,11 +27,11 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. allow_backorder: type: boolean title: allow_backorder - description: The item's allow backorder. + description: Whether the item can be added even if it's not in stock. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml index e48200586c..b751b43bd8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml @@ -1,12 +1,12 @@ type: object -description: SUMMARY +description: The details to update in an outbound item. x-schemaName: AdminPostExchangesItemsActionReqSchema properties: quantity: type: number title: quantity - description: The exchange's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note only viewed by admin users. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml index 1d8aa2b4db..666ccbcfe5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml @@ -1,19 +1,19 @@ type: object -description: SUMMARY +description: The details to update in an inbound (returned) item. x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema properties: quantity: type: number title: quantity - description: The exchange's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The exchange's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml index 3e2045fd89..da3d011473 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The details of the inbound (return) items. x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema properties: items: type: array - description: The exchange's items. + description: The details of the inbound (return) items. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -15,7 +15,7 @@ properties: id: type: string title: id - description: The item's ID. + description: The ID of the order's item. quantity: type: number title: quantity @@ -27,11 +27,11 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the return reason to associate with the item. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml index 68fc3d9b3e..9564ca8aa4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The details of the shipping method to update. x-schemaName: AdminPostExchangesShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: The shipping method's custom amount. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed by admin users only. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml index aee62b6a99..4bff8e27eb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The outbound shipping method's details. x-schemaName: AdminPostExchangesShippingReqSchema required: - shipping_option_id @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The exchange's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: Set a custom amount for the shipping method. description: type: string title: description - description: The exchange's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed by admin users only. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml index 9daa00cb61..e3dc6b300e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The claim's details. x-schemaName: AdminPostOrderClaimsReqSchema required: - type @@ -14,7 +14,7 @@ properties: order_id: type: string title: order_id - description: The claim's order id. + description: The ID of the order the claim is created for. description: type: string title: description @@ -22,11 +22,11 @@ properties: internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml index e1298622f0..5e4fcec7be 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The details of items to be edited. x-schemaName: AdminPostOrderEditsAddItemsReqSchema properties: items: type: array - description: The order edit's items. + description: The details of items to be edited. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -15,7 +15,7 @@ properties: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity @@ -27,11 +27,13 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. allow_backorder: type: boolean title: allow_backorder - description: The item's allow backorder. + description: >- + Whether the item can be added even if there's no available + invenotory quantity of the variant. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml index b366dab18e..ac9348920e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml @@ -1,12 +1,12 @@ type: object -description: SUMMARY +description: The details to update in the item. x-schemaName: AdminPostOrderEditsItemsActionReqSchema properties: quantity: type: number title: quantity - description: The order edit's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml index c6946ef6fe..23a158dae9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The order edit's details. x-schemaName: AdminPostOrderEditsReqSchema required: - order_id @@ -7,7 +7,7 @@ properties: order_id: type: string title: order_id - description: The order edit's order id. + description: The ID of the order this edit is for. description: type: string title: description @@ -15,7 +15,7 @@ properties: internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The order edit's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml index 2e36a37f64..3bad2acc19 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The shipping method's details. x-schemaName: AdminPostOrderEditsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The order edit's custom amount. + description: Set a custom price for the shipping method. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The order edit's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml index cd81378dd5..3327fc1442 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The shipping method's details. x-schemaName: AdminPostOrderEditsShippingReqSchema required: - shipping_option_id @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The order edit's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The order edit's custom amount. + description: Set a custom price for the shipping method. description: type: string title: description - description: The order edit's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml index aab1845f1e..f54ff35e99 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The order item's details to update. x-schemaName: AdminPostOrderEditsUpdateItemQuantityReqSchema required: - quantity @@ -7,8 +7,8 @@ properties: quantity: type: number title: quantity - description: The order edit's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml index 05e3ed3e54..4472a42d37 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The exchange's details. x-schemaName: AdminPostOrderExchangesReqSchema required: - order_id @@ -7,7 +7,7 @@ properties: order_id: type: string title: order_id - description: The exchange's order id. + description: The ID of the order this exchange is created for. description: type: string title: description @@ -15,7 +15,7 @@ properties: internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml index ea798aa3c3..12d20a347b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The return receival details. x-schemaName: AdminPostReceiveReturnsReqSchema properties: internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. description: type: string title: description description: The return's description. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml index b72f231201..afc9e7a3f1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml @@ -1,8 +1,8 @@ type: object -description: SUMMARY +description: The confirmation's details. x-schemaName: AdminPostReturnsConfirmRequestReqSchema properties: no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether to send the customer a notification about the confirmation. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml index d9f9bc3340..a9561ae91f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml @@ -1,12 +1,12 @@ type: object -description: SUMMARY +description: The details to update of the damaged item. x-schemaName: AdminPostReturnsDismissItemsActionReqSchema properties: quantity: type: number title: quantity - description: The return's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml index 2b7ac0d973..d9b98ce88a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml @@ -1,12 +1,12 @@ type: object -description: SUMMARY +description: The details of the received item. x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema properties: quantity: type: number title: quantity - description: The return's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml index abb7e8850f..c3e219537a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The items details. x-schemaName: AdminPostReturnsReceiveItemsReqSchema properties: items: type: array - description: The return's items. + description: The items details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -15,7 +15,7 @@ properties: id: type: string title: id - description: The item's ID. + description: The ID of the item in the order. quantity: type: number title: quantity @@ -27,4 +27,4 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml index 68be6f5dcc..0fbd580159 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The return's details. x-schemaName: AdminPostReturnsReqSchema required: - order_id @@ -7,11 +7,11 @@ properties: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order the return belongs to. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location the items are returned to. description: type: string title: description @@ -19,11 +19,11 @@ properties: internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether to send the customer a notification about the created return. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml index eae1e908a0..0d0c6e633c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml @@ -1,19 +1,19 @@ type: object -description: SUMMARY +description: The details to update in the item. x-schemaName: AdminPostReturnsRequestItemsActionReqSchema properties: quantity: type: number title: quantity - description: The claim's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml index 39180c5b5e..d47549d7ef 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The items' details. x-schemaName: AdminPostReturnsRequestItemsReqSchema properties: items: type: array - description: The claim's items. + description: The items' details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -27,11 +27,11 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml index 3d5c38d44d..bdb5f9b00d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml @@ -1,15 +1,17 @@ type: object -description: SUMMARY +description: The return's details. x-schemaName: AdminPostReturnsReturnReqSchema properties: location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location to return items to. no_notification: type: boolean title: no_notification - description: The return's no notification. + description: >- + Whether the customer should receive notifications about updates to the + return. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml index 5cd4a15e19..2fb4607a74 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The shipping method's details. x-schemaName: AdminPostReturnsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The return's custom amount. + description: Set a custom price for the shipping method. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml index 9cd63a9d16..861fa03fc7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The shipping method's details. x-schemaName: AdminPostReturnsShippingReqSchema required: - shipping_option_id @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The exchange's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: Set the price of the shipping method. description: type: string title: description - description: The exchange's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPrice.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPrice.yaml index c63019f47d..fa5b3c1698 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPrice.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPrice.yaml @@ -1,5 +1,5 @@ type: object -description: The price's prices. +description: The price's details. x-schemaName: AdminPrice required: - id @@ -26,6 +26,7 @@ properties: type: string title: currency_code description: The price's currency code. + example: usd amount: type: number title: amount @@ -36,27 +37,31 @@ properties: min_quantity: type: number title: min_quantity - description: The price's min quantity. + description: >- + The minimum quantity that must be available in the cart for the price to + be applied. max_quantity: type: number title: max_quantity - description: The price's max quantity. + description: >- + The maximum quantity allowed to be available in the cart for the price to + be applied. price_set_id: type: string title: price_set_id - description: The price's price set id. + description: The ID of the associated price set. created_at: type: string format: date-time title: created_at - description: The price's created at. + description: The date the price was created. updated_at: type: string format: date-time title: updated_at - description: The price's updated at. + description: The date the price was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price's deleted at. + description: The date the price was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml index e921b8aa5f..167aebd053 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml @@ -33,11 +33,11 @@ properties: starts_at: type: string title: starts_at - description: The price list's starts at. + description: The date the price list starts. ends_at: type: string title: ends_at - description: The price list's ends at. + description: The date the price list ends. status: type: string description: The price list's status. @@ -59,14 +59,14 @@ properties: type: string format: date-time title: created_at - description: The price list's created at. + description: The date the price list was created. updated_at: type: string format: date-time title: updated_at - description: The price list's updated at. + description: The date the price list was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price list's deleted at. + description: The date the price list was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml index b4cb20eabd..e862d875b1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the created, updated, and deleted prices in a price list. x-schemaName: AdminPriceListBatchResponse required: - created @@ -8,17 +8,17 @@ required: properties: created: type: array - description: The price list's created. + description: The created prices. items: $ref: ./AdminPrice.yaml updated: type: array - description: The price list's updated. + description: The updated prices. items: $ref: ./AdminPrice.yaml deleted: type: object - description: SUMMARY + description: The details of the deleted prices. required: - ids - object @@ -26,16 +26,17 @@ properties: properties: ids: type: array - description: The deleted's ids. + description: The IDs of the deleted prices. items: type: string title: ids - description: The id's ids. + description: A price's ID. object: type: string title: object - description: SUMMARY + description: The name of the deleted object. + default: price deleted: type: boolean title: deleted - description: SUMMARY + description: Whether the prices were deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml index d7e323c8f9..7daa3cffe5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the deleted price list. x-schemaName: AdminPriceListDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Price List was deleted. + description: Whether the price list was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListListResponse.yaml index 0199ba1e0e..186db813c9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of price lists. x-schemaName: AdminPriceListListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The price list's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The price list's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The price list's count. + description: The total number of items. price_lists: type: array - description: The price list's price lists. + description: The list of price lists. items: $ref: ./AdminPriceList.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListPrice.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListPrice.yaml index 5e699d3feb..b8bf77e63a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListPrice.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListPrice.yaml @@ -1,5 +1,5 @@ type: object -description: The price's prices. +description: The details of a price list's price. x-schemaName: AdminPriceListPrice required: - variant_id @@ -19,7 +19,7 @@ properties: variant_id: type: string title: variant_id - description: The price's variant id. + description: The ID of the product variant this price list is for. rules: type: object description: The price's rules. @@ -35,6 +35,7 @@ properties: type: string title: currency_code description: The price's currency code. + example: usd amount: type: number title: amount @@ -45,27 +46,31 @@ properties: min_quantity: type: number title: min_quantity - description: The price's min quantity. + description: >- + The minimum quantity that must be available in the cart for the price to + be applied. max_quantity: type: number title: max_quantity - description: The price's max quantity. + description: >- + The maximum quantity allowed to be available in the cart for the price to + be applied. price_set_id: type: string title: price_set_id - description: The price's price set id. + description: The ID of the price set this price belongs to. created_at: type: string format: date-time title: created_at - description: The price's created at. + description: The date the price was created. updated_at: type: string format: date-time title: updated_at - description: The price's updated at. + description: The date the price was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price's deleted at. + description: The date the price was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListResponse.yaml index b666517278..13421d2edb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The price list's details. x-schemaName: AdminPriceListResponse required: - price_list diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreference.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreference.yaml index 01479f00c8..7f3fbec642 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreference.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreference.yaml @@ -18,26 +18,28 @@ properties: type: string title: attribute description: The price preference's attribute. + example: region_id value: type: string title: value description: The price preference's value. + example: reg_123 is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The price preference's is tax inclusive. + description: Whether prices matching this preference include taxes. created_at: type: string format: date-time title: created_at - description: The price preference's created at. + description: The date the price preference was created. updated_at: type: string format: date-time title: updated_at - description: The price preference's updated at. + description: The date the price preference was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price preference's deleted at. + description: The date the price preference was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml index 8f38315baa..b7544c2f3f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the deleted price preference. x-schemaName: AdminPricePreferenceDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Price Preference was deleted. + description: Whether the price preference was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceListResponse.yaml index 1ee09e258e..06f53caac6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of price preferences. x-schemaName: AdminPricePreferenceListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The price preference's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The price preference's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The price preference's count. + description: The total count of items. price_preferences: type: array - description: The price preference's price preferences. + description: The list of price preferences. items: $ref: ./AdminPricePreference.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceResponse.yaml index 4fbab75262..8a2ff0a7ab 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The price preference's details. x-schemaName: AdminPricePreferenceResponse required: - price_preference diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml index 3fe71d64f6..f8bf5ad600 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -1,5 +1,5 @@ type: object -description: The product's parent. +description: The product's details. x-schemaName: AdminProduct required: - type @@ -33,37 +33,37 @@ properties: $ref: ./AdminCollection.yaml categories: type: array - description: The parent's categories. + description: The product's categories. items: $ref: ./AdminProductCategory.yaml sales_channels: type: array - description: The parent's sales channels. + description: The sales channels that the product is available in. items: $ref: ./AdminSalesChannel.yaml variants: type: array - description: The parent's variants. + description: The product's variants. items: $ref: ./AdminProductVariant.yaml type: $ref: ./AdminProductType.yaml tags: type: array - description: The parent's tags. + description: The product's tags. items: $ref: ./AdminProductTag.yaml length: type: number title: length - description: The parent's length. + description: The product's length. title: type: string title: title - description: The parent's title. + description: The product's title. status: type: string - description: The parent's status. + description: The product's status. enum: - draft - proposed @@ -71,97 +71,97 @@ properties: - rejected options: type: array - description: The parent's options. + description: The product's options. items: $ref: ./BaseProductOption.yaml description: type: string title: description - description: The parent's description. + description: The product's description. id: type: string title: id - description: The parent's ID. + description: The product's ID. metadata: type: object - description: The parent's metadata. + description: The product's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the product was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the product was updated. handle: type: string title: handle - description: The parent's handle. + description: The product's unique handle. subtitle: type: string title: subtitle - description: The parent's subtitle. + description: The product's subtitle. is_giftcard: type: boolean title: is_giftcard - description: The parent's is giftcard. + description: Whether the product is a gift card. thumbnail: type: string title: thumbnail - description: The parent's thumbnail. + description: The product's thumbnail. width: type: number title: width - description: The parent's width. + description: The product's width. weight: type: number title: weight - description: The parent's weight. + description: The product's weight. height: type: number title: height - description: The parent's height. + description: The product's height. origin_country: type: string title: origin_country - description: The parent's origin country. + description: The product's origin country. hs_code: type: string title: hs_code - description: The parent's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The parent's mid code. + description: The product's MID code. material: type: string title: material - description: The parent's material. + description: The product's material. collection_id: type: string title: collection_id - description: The parent's collection id. + description: The ID of the collection that the product belongs to. type_id: type: string title: type_id - description: The parent's type id. + description: The ID of the product's type. images: type: array - description: The parent's images. + description: The product's images. items: $ref: ./BaseProductImage.yaml discountable: type: boolean title: discountable - description: The parent's discountable. + description: Whether discounts can be applied on the product. external_id: type: string title: external_id - description: The parent's external id. + description: The ID of a product in an external system, such as an ERP or CMS. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the product was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml index 1845f1e5de..3c5286bc34 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml @@ -1,5 +1,5 @@ type: object -description: The category's categories. +description: The product category's details. x-schemaName: AdminProductCategory required: - category_children @@ -18,7 +18,7 @@ required: properties: category_children: type: array - description: The category's category children. + description: The category's children. items: type: object parent_category: @@ -42,39 +42,43 @@ properties: description: The category's ID. metadata: type: object - description: The category's metadata. + description: The category's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The category's created at. + description: The date the category was created. updated_at: type: string format: date-time title: updated_at - description: The category's updated at. + description: The date the category was updated. handle: type: string title: handle - description: The category's handle. + description: The category's unique handle. deleted_at: type: string format: date-time title: deleted_at - description: The category's deleted at. + description: The date the category was deleted. is_active: type: boolean title: is_active - description: The category's is active. + description: >- + Whether the category is active. If disabled, the category isn't shown in + the storefront. is_internal: type: boolean title: is_internal - description: The category's is internal. + description: >- + Whether the category is internal. If enabled, the category is only seen by + admin users. rank: type: number title: rank - description: The category's rank. + description: The category's rank among sibling categories. parent_category_id: type: string title: parent_category_id - description: The category's parent category id. + description: The ID of the category's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml index b2531e9fab..12ce01e8cf 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of deleting the category. x-schemaName: AdminProductCategoryDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Product Category was deleted. + description: Whether the product category was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryListResponse.yaml index 542fca2356..7f0f60468b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of product categories. x-schemaName: AdminProductCategoryListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The product category's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product category's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product category's count. + description: The total number of items. product_categories: type: array - description: The product category's product categories. + description: The list of product categories. items: $ref: ./AdminProductCategory.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryResponse.yaml index b46adcf4e2..eaccc1fb6d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product category's details. x-schemaName: AdminProductCategoryResponse required: - product_category diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml index 8a448dd6a4..f33d992df9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the product deletion. x-schemaName: AdminProductDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product was deleted. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 4828f1e90e..765940c100 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -1530,7 +1530,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/api-keys' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Api Keys responses: @@ -1602,7 +1602,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/api-keys' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}", @@ -1668,7 +1668,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/api-keys/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Api Keys responses: @@ -1732,7 +1732,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/api-keys/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}" @@ -1781,7 +1781,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/api-keys/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Api Keys responses: @@ -1867,7 +1867,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/api-keys/{id}/revoke' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Api Keys responses: @@ -1950,7 +1950,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/api-keys/{id}/sales-channels' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Api Keys responses: @@ -2029,7 +2029,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/campaigns' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Campaigns responses: @@ -2192,7 +2192,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/campaigns' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Gunner", @@ -2261,7 +2261,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/campaigns/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Campaigns responses: @@ -2384,7 +2384,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/campaigns/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "description": "{value}", @@ -2435,7 +2435,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/campaigns/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Campaigns responses: @@ -2537,7 +2537,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/campaigns/{id}/promotions' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Campaigns responses: @@ -3379,7 +3379,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/claims' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -3437,7 +3437,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "type": "{value}", @@ -3504,7 +3504,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/claims/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -3553,7 +3553,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/cancel' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -3620,7 +3620,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/claim-items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -3695,7 +3695,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/claim-items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -3765,7 +3765,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/claims/{id}/claim-items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -3817,7 +3817,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/inbound/items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -3877,7 +3877,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -3929,7 +3929,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/inbound/items/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/inbound/items/{action_id}'' \ -H ''Authorization: Bearer {access_token}''' tags: - Claims responses: @@ -3981,7 +3981,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/inbound/shipping-method' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" @@ -4061,7 +4061,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -4113,7 +4113,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}'' \ -H ''Authorization: Bearer {access_token}''' tags: - Claims responses: @@ -4181,7 +4181,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/outbound/items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -4257,7 +4257,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -4325,7 +4325,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/outbound/items/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/outbound/items/{action_id}'' \ -H ''Authorization: Bearer {access_token}''' tags: - Claims responses: @@ -4393,7 +4393,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/outbound/shipping-method' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" @@ -4473,7 +4473,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -4541,7 +4541,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}'' \ -H ''Authorization: Bearer {access_token}''' tags: - Claims responses: @@ -4603,7 +4603,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/claims/{id}/request' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -4651,7 +4651,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/claims/{id}/request' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Claims responses: @@ -5493,7 +5493,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/collections' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Collections responses: @@ -5551,7 +5551,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/collections' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}", @@ -5617,7 +5617,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/collections/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Collections responses: @@ -5681,7 +5681,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/collections/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} @@ -5729,7 +5729,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/collections/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Collections responses: @@ -5812,7 +5812,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/collections/{id}/products' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Collections responses: @@ -5933,7 +5933,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/currencies' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Currencies responses: @@ -5993,7 +5993,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/currencies/{code}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Currencies responses: @@ -6849,7 +6849,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/customer-groups' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Customer Groups responses: @@ -6936,7 +6936,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/customer-groups' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Solon", @@ -7002,7 +7002,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/customer-groups/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Customer Groups responses: @@ -7066,7 +7066,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/customer-groups/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Corbin", @@ -7116,7 +7116,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/customer-groups/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Customer Groups responses: @@ -7217,7 +7217,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/customer-groups/{id}/customers' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Customer Groups responses: @@ -10580,7 +10580,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/customers' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Customers responses: @@ -10705,7 +10705,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/customers' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "email": "Tomas.Toy16@yahoo.com", @@ -10775,7 +10775,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/customers/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Customers responses: @@ -10880,7 +10880,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/customers/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "email": "Daren_Rodriguez-Rutherford93@gmail.com", @@ -10933,7 +10933,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/customers/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Customers responses: @@ -11134,7 +11134,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/customers/{id}/addresses' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Customers responses: @@ -11306,7 +11306,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/customers/{id}/addresses' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "address_name": "{value}", @@ -11388,7 +11388,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Customers responses: @@ -11537,7 +11537,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "address_name": "{value}", @@ -11616,7 +11616,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/customers/{id}/addresses/{address_id}'' \ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/customers/{id}/addresses/{address_id}'' \ -H ''Authorization: Bearer {access_token}''' tags: - Customers responses: @@ -13120,7 +13120,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/draft-orders' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Draft Orders responses: @@ -13491,7 +13491,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/draft-orders' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "sales_channel_id": "{value}", @@ -13553,7 +13553,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/draft-orders/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Draft Orders responses: @@ -14394,7 +14394,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/exchanges' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -14478,7 +14478,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}", @@ -14544,7 +14544,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/exchanges/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -14593,7 +14593,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges/{id}/cancel' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -14644,7 +14644,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -14704,7 +14704,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -14772,7 +14772,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}'' \ -H ''Authorization: Bearer {access_token}''' tags: - Exchanges responses: @@ -14823,7 +14823,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" @@ -14903,7 +14903,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -14955,7 +14955,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}'' \ -H ''Authorization: Bearer {access_token}''' tags: - Exchanges responses: @@ -15021,7 +15021,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -15097,7 +15097,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -15165,7 +15165,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}'' \ -H ''Authorization: Bearer {access_token}''' tags: - Exchanges responses: @@ -15232,7 +15232,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" @@ -15312,7 +15312,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -15380,7 +15380,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}''\ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}''\ -H ''Authorization: Bearer {access_token}''' tags: - Exchanges responses: @@ -15441,7 +15441,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/exchanges/{id}/request' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -15489,7 +15489,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/exchanges/{id}/request' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Exchanges responses: @@ -15612,7 +15612,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/fulfillment-providers' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Fulfillment Providers responses: @@ -15656,7 +15656,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Fulfillment Sets responses: @@ -15841,7 +15841,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Layla" @@ -15913,7 +15913,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Fulfillment Sets responses: @@ -16116,7 +16116,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Elvis" @@ -16169,7 +16169,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}'' \ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}'' \ -H ''Authorization: Bearer {access_token}''' tags: - Fulfillment Sets responses: @@ -16229,7 +16229,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/fulfillments' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "location_id": "{value}", @@ -16337,7 +16337,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/fulfillments/{id}/cancel' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Fulfillments responses: @@ -16404,7 +16404,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/fulfillments/{id}/shipment' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "labels": [ @@ -16828,7 +16828,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/inventory-items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Inventory Items responses: @@ -16915,7 +16915,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/inventory-items' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "sku": "{value}", @@ -16992,7 +16992,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/inventory-items/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Inventory Items responses: @@ -17113,7 +17113,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/inventory-items/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "sku": "{value}", @@ -17173,7 +17173,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/inventory-items/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Inventory Items responses: @@ -17309,7 +17309,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/inventory-items/{id}/location-levels' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Inventory Items responses: @@ -17419,7 +17419,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "location_id": "{value}" @@ -17519,7 +17519,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels/batch' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Inventory Items responses: @@ -17609,7 +17609,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Inventory Items responses: @@ -17677,7 +17677,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: 'curl -X DELETE ''{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}'' \ -H ''x-medusa-access-token: {api_token}''' + source: 'curl -X DELETE ''{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}'' \ -H ''Authorization: Bearer {access_token}''' tags: - Inventory Items responses: @@ -18668,7 +18668,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/notifications' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Notifications responses: @@ -18728,7 +18728,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/notifications/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Notifications responses: @@ -18770,7 +18770,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/order-edits' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}", @@ -18820,7 +18820,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/order-edits/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Order Edits responses: @@ -18884,7 +18884,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/order-edits/{id}/confirm' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Order Edits responses: @@ -18935,7 +18935,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/order-edits/{id}/items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Order Edits responses: @@ -18992,7 +18992,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/order-edits/{id}/items/item/{item_id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "quantity": 7564330046324736 @@ -19056,7 +19056,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/order-edits/{id}/items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Order Edits responses: @@ -19110,7 +19110,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/order-edits/{id}/items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Order Edits responses: @@ -19155,7 +19155,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/order-edits/{id}/request' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Order Edits responses: @@ -19206,7 +19206,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/order-edits/{id}/shipping-method' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" @@ -19270,7 +19270,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Order Edits responses: @@ -19324,7 +19324,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Order Edits responses: @@ -19983,7 +19983,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/orders' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Orders responses: @@ -20073,7 +20073,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/orders/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Orders responses: @@ -20133,7 +20133,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/orders/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Orders responses: @@ -20202,7 +20202,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/orders/{id}/archive' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}" @@ -20275,7 +20275,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/orders/{id}/cancel' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Orders responses: @@ -20350,7 +20350,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/orders/{id}/changes' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Orders responses: @@ -20420,7 +20420,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/orders/{id}/complete' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}" @@ -20534,7 +20534,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/orders/{id}/fulfillments' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "items": [ @@ -20631,7 +20631,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/cancel' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Orders responses: @@ -20765,7 +20765,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipments' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "items": [ @@ -20820,7 +20820,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/orders/{id}/preview' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Orders responses: @@ -20892,7 +20892,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/payment-collections' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}" @@ -20941,7 +20941,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/payment-collections/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Payment Collections responses: @@ -21016,7 +21016,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/payment-collections/{id}/mark-as-paid' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}" @@ -21510,7 +21510,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/payments' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Payments responses: @@ -21657,7 +21657,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/payments/payment-providers' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Payments responses: @@ -21746,7 +21746,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/payments/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Payments responses: @@ -21817,7 +21817,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/payments/{id}/capture' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Payments responses: @@ -21897,7 +21897,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/payments/{id}/refund' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Payments responses: @@ -22280,7 +22280,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/price-lists' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Price Lists responses: @@ -22338,7 +22338,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/price-lists' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}", @@ -22406,7 +22406,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/price-lists/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Price Lists responses: @@ -22470,7 +22470,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/price-lists/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "description": "{value}", @@ -22520,7 +22520,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/price-lists/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Price Lists responses: @@ -22655,7 +22655,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Price Lists responses: @@ -22721,7 +22721,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/price-lists/{id}/products' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Price Lists responses: @@ -22870,7 +22870,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/price-preferences' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Price Preferences responses: @@ -22928,7 +22928,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/price-preferences' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Price Preferences responses: @@ -22989,7 +22989,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/price-preferences/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Price Preferences responses: @@ -23053,7 +23053,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/price-preferences/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Price Preferences responses: @@ -23097,7 +23097,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/price-preferences/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Price Preferences responses: @@ -23661,7 +23661,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/product-categories' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Categories responses: @@ -23719,7 +23719,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/product-categories' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Vesta", @@ -23802,7 +23802,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/product-categories/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Categories responses: @@ -23899,7 +23899,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/product-categories/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "parent_category_id": "{value}", @@ -23948,7 +23948,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/product-categories/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Categories responses: @@ -24031,7 +24031,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/product-categories/{id}/products' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Categories responses: @@ -24521,7 +24521,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/product-tags' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Tags responses: @@ -24579,7 +24579,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/product-tags' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "value": "{value}", @@ -24645,7 +24645,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/product-tags/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Tags responses: @@ -24718,7 +24718,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/product-tags/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} @@ -24766,7 +24766,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/product-tags/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Tags responses: @@ -25256,7 +25256,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/product-types' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Types responses: @@ -25314,7 +25314,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/product-types' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "value": "{value}", @@ -25380,7 +25380,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/product-types/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Types responses: @@ -25453,7 +25453,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/product-types/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} @@ -25501,7 +25501,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/product-types/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Types responses: @@ -25995,7 +25995,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/product-variants' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Product Variants responses: @@ -26638,7 +26638,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/products' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -26733,7 +26733,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}" @@ -26797,7 +26797,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/batch' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -26856,7 +26856,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/export' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -26899,7 +26899,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/import' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -26944,7 +26944,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/import/{transaction_id}/confirm' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -26999,7 +26999,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/products/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -27071,7 +27071,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -27115,7 +27115,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/products/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -27257,7 +27257,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/products/{id}/options' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -27359,7 +27359,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}/options' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}", @@ -27434,7 +27434,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/products/{id}/options/{option_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -27513,7 +27513,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}/options/{option_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -27583,7 +27583,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/products/{id}/options/{option_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -28084,7 +28084,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/products/{id}/variants' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -28186,7 +28186,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}/variants' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "title": "{value}", @@ -28258,7 +28258,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}/variants/batch' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -28375,7 +28375,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}/variants/inventory-items/batch' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -28443,7 +28443,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/products/{id}/variants/{variant_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -28522,7 +28522,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -28589,7 +28589,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/products/{id}/variants/{variant_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -28662,7 +28662,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "required_quantity": 7390879820021760, @@ -28746,7 +28746,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "required_quantity": 5324804697620480 @@ -28823,7 +28823,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Products responses: @@ -29332,7 +29332,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/promotions' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Promotions responses: @@ -29701,7 +29701,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/promotions' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "code": "{value}", @@ -29797,7 +29797,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/promotions/rule-attribute-options/{rule_type}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Promotions responses: @@ -29909,7 +29909,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Promotions responses: @@ -29978,7 +29978,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/promotions/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Promotions responses: @@ -30132,7 +30132,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/promotions/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "campaign_id": "{value}" @@ -30180,7 +30180,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/promotions/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Promotions responses: @@ -30366,7 +30366,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Promotions responses: @@ -30573,7 +30573,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Promotions responses: @@ -30780,7 +30780,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Promotions responses: @@ -30896,7 +30896,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/promotions/{id}/{rule_type}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Promotions responses: @@ -31025,7 +31025,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/refund-reasons' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Refund Reasons responses: @@ -31112,7 +31112,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/refund-reasons' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "label": "{value}", @@ -31178,7 +31178,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/refund-reasons/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Refund Reasons responses: @@ -31252,7 +31252,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/refund-reasons/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "description": "{value}" @@ -31300,7 +31300,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/refund-reasons/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Refund Reasons responses: @@ -31823,7 +31823,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/regions' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Regions responses: @@ -31910,7 +31910,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/regions' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Heloise", @@ -31977,7 +31977,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/regions/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Regions responses: @@ -32076,7 +32076,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/regions/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} @@ -32124,7 +32124,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/regions/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Regions responses: @@ -32688,7 +32688,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/reservations' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Reservations responses: @@ -32775,7 +32775,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/reservations' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "line_item_id": "{value}", @@ -32845,7 +32845,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/reservations/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Reservations responses: @@ -32926,7 +32926,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/reservations/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "description": "{value}", @@ -32975,7 +32975,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/reservations/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Reservations responses: @@ -33528,7 +33528,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/return-reasons' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Return Reasons responses: @@ -33586,7 +33586,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/return-reasons' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "value": "{value}", @@ -33652,7 +33652,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/return-reasons/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Return Reasons responses: @@ -33716,7 +33716,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/return-reasons/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Return Reasons responses: @@ -33760,7 +33760,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/return-reasons/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Return Reasons responses: @@ -34419,7 +34419,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/returns' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -34506,7 +34506,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "order_id": "{value}", @@ -34585,7 +34585,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/returns/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -34649,7 +34649,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} @@ -34698,7 +34698,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/cancel' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -34770,7 +34770,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -34846,7 +34846,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -34916,7 +34916,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -34982,7 +34982,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/receive' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "return_id": "{value}", @@ -35039,7 +35039,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/returns/{id}/receive' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35125,7 +35125,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/receive-items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35201,7 +35201,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35271,7 +35271,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35338,7 +35338,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/receive/confirm' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35405,7 +35405,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/request' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35449,7 +35449,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/returns/{id}/request' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35535,7 +35535,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/request-items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35611,7 +35611,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/request-items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35681,7 +35681,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/returns/{id}/request-items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35748,7 +35748,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/shipping-method' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "shipping_option_id": "{value}" @@ -35828,7 +35828,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/returns/{id}/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -35898,7 +35898,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/returns/{id}/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Returns responses: @@ -36432,7 +36432,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/sales-channels' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Sales Channels responses: @@ -36519,7 +36519,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/sales-channels' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Linnea", @@ -36586,7 +36586,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/sales-channels/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Sales Channels responses: @@ -36650,7 +36650,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/sales-channels/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "description": "{value}", @@ -36699,7 +36699,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/sales-channels/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Sales Channels responses: @@ -36782,7 +36782,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/sales-channels/{id}/products' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Sales Channels responses: @@ -37326,7 +37326,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/shipping-options' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Shipping Options responses: @@ -37413,7 +37413,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/shipping-options' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Julie", @@ -37658,7 +37658,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/shipping-options/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Shipping Options responses: @@ -37702,7 +37702,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/shipping-options/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Shipping Options responses: @@ -37865,7 +37865,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/shipping-options/{id}/rules/batch' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Shipping Options responses: @@ -38397,7 +38397,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/shipping-profiles' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Shipping Profiles responses: @@ -38484,7 +38484,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/shipping-profiles' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Percy", @@ -38551,7 +38551,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/shipping-profiles/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Shipping Profiles responses: @@ -38628,7 +38628,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/shipping-profiles/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} @@ -38676,7 +38676,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/shipping-profiles/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Shipping Profiles responses: @@ -39194,7 +39194,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/stock-locations' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Stock Locations responses: @@ -39252,7 +39252,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/stock-locations' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Maryam", @@ -39319,7 +39319,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/stock-locations/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Stock Locations responses: @@ -39383,7 +39383,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/stock-locations/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "address_id": "{value}", @@ -39432,7 +39432,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/stock-locations/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Stock Locations responses: @@ -39515,7 +39515,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/stock-locations/{id}/fulfillment-providers' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Stock Locations responses: @@ -39595,7 +39595,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/stock-locations/{id}/fulfillment-sets' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Helene", @@ -39683,7 +39683,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/stock-locations/{id}/sales-channels' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Stock Locations responses: @@ -39816,7 +39816,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/stores' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Stores responses: @@ -39876,7 +39876,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/stores/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Stores responses: @@ -39940,7 +39940,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/stores/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Melvina", @@ -40510,7 +40510,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/tax-rates' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Tax Rates responses: @@ -40597,7 +40597,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/tax-rates' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "name": "Kaylin", @@ -40664,7 +40664,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/tax-rates/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Tax Rates responses: @@ -40728,7 +40728,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/tax-rates/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "metadata": {} @@ -40776,7 +40776,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/tax-rates/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Tax Rates responses: @@ -40843,7 +40843,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/tax-rates/{id}/rules' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "reference": "{value}", @@ -40916,7 +40916,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/tax-rates/{id}/rules/{rule_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Tax Rates responses: @@ -41956,7 +41956,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/tax-regions' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Tax Regions responses: @@ -42043,7 +42043,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/tax-regions' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "country_code": "{value}", @@ -42111,7 +42111,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/tax-regions/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Tax Regions responses: @@ -42154,7 +42154,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/tax-regions/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Tax Regions responses: @@ -42224,7 +42224,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/uploads' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Uploads responses: @@ -42285,7 +42285,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/uploads/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Uploads responses: @@ -42328,7 +42328,7 @@ paths: label: cURL source: |- curl -X DELETE '{backend_url}/admin/uploads/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Uploads responses: @@ -43136,7 +43136,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/workflows-executions' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Workflows Executions responses: @@ -43225,7 +43225,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/workflows-executions/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Workflows Executions responses: @@ -43274,7 +43274,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/run' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Workflows Executions responses: @@ -43343,7 +43343,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/steps/failure' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "transaction_id": "{value}", @@ -43406,7 +43406,7 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/steps/success' \ - -H 'x-medusa-access-token: {api_token}' \ + -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ "transaction_id": "{value}", @@ -43466,7 +43466,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/workflows-executions/{workflow_id}/subscribe' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Workflows Executions responses: @@ -43537,7 +43537,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Workflows Executions responses: @@ -43596,7 +43596,7 @@ paths: label: cURL source: |- curl '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Authorization: Bearer {access_token}' tags: - Workflows Executions responses: @@ -49063,7 +49063,7 @@ components: $ref: '#/components/schemas/AdminSalesChannel' AdminOrderPreviewResponse: type: object - description: SUMMARY + description: The preview of an order. x-schemaName: AdminOrderPreviewResponse required: - order @@ -49072,7 +49072,7 @@ components: $ref: '#/components/schemas/AdminOrderPreview' AdminOrderResponse: type: object - description: SUMMARY + description: An order's details. x-schemaName: AdminOrderResponse required: - order @@ -49081,7 +49081,7 @@ components: $ref: '#/components/schemas/AdminOrder' AdminOrderReturnResponse: type: object - description: SUMMARY + description: The order return details. x-schemaName: AdminOrderReturnResponse required: - order @@ -49106,29 +49106,13 @@ components: title: id description: The payment's ID. amount: - oneOf: - - type: string - title: amount - description: The payment's amount. - - type: number - title: amount - description: The payment's amount. - - type: string - title: amount - description: The payment's amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: amount + description: The payment's amount. authorized_amount: - oneOf: - - type: string - title: authorized_amount - description: The payment's authorized amount. - - type: number - title: authorized_amount - description: The payment's authorized amount. - - type: string - title: authorized_amount - description: The payment's authorized amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: authorized_amount + description: The amount authorized of the payment. currency_code: type: string title: currency_code @@ -49136,86 +49120,64 @@ components: provider_id: type: string title: provider_id - description: The payment's provider id. + description: The ID of the payment provider used to process this payment. cart_id: type: string title: cart_id - description: The payment's cart id. + description: The ID of the associated cart. order_id: type: string title: order_id - description: The payment's order id. + description: The ID of the associated order. order_edit_id: type: string title: order_edit_id - description: The payment's order edit id. + description: The ID of the associated order edit. customer_id: type: string title: customer_id - description: The payment's customer id. + description: ID of the associated customer. data: type: object - description: The payment's data. + description: The payment's data, useful for processing by the payment provider. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment created_at: type: string format: date-time title: created_at - description: The payment's created at. + description: The date the payment was created. updated_at: type: string format: date-time title: updated_at - description: The payment's updated at. + description: The date the payment was updated. captured_at: - oneOf: - - type: string - title: captured_at - description: The payment's captured at. - - type: string - title: captured_at - description: The payment's captured at. - format: date-time + type: string + format: date-time + title: captured_at + description: The date the payment was captured. canceled_at: - oneOf: - - type: string - title: canceled_at - description: The payment's canceled at. - - type: string - title: canceled_at - description: The payment's canceled at. - format: date-time + type: string + format: date-time + title: canceled_at + description: The date the payment was canceled. captured_amount: - oneOf: - - type: string - title: captured_amount - description: The payment's captured amount. - - type: number - title: captured_amount - description: The payment's captured amount. - - type: string - title: captured_amount - description: The payment's captured amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: captured_amount + description: The captured amount of the payment. refunded_amount: - oneOf: - - type: string - title: refunded_amount - description: The payment's refunded amount. - - type: number - title: refunded_amount - description: The payment's refunded amount. - - type: string - title: refunded_amount - description: The payment's refunded amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: captured_amount + description: The refunded amount of the payment. captures: type: array - description: The payment's captures. + description: The details of payment captures. items: $ref: '#/components/schemas/BaseCapture' refunds: type: array - description: The payment's refunds. + description: The details of payment refunds. items: $ref: '#/components/schemas/BaseRefund' payment_collection: @@ -49224,7 +49186,7 @@ components: $ref: '#/components/schemas/BasePaymentSession' AdminPaymentCollection: type: object - description: The payment collection's payment collections. + description: The payment collection's details. x-schemaName: AdminPaymentCollection required: - id @@ -49245,77 +49207,41 @@ components: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. amount: - oneOf: - - type: string - title: amount - description: The payment collection's amount. - - type: number - title: amount - description: The payment collection's amount. - - type: string - title: amount - description: The payment collection's amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: amount + description: The total amount to be paid. authorized_amount: - oneOf: - - type: string - title: authorized_amount - description: The payment collection's authorized amount. - - type: number - title: authorized_amount - description: The payment collection's authorized amount. - - type: string - title: authorized_amount - description: The payment collection's authorized amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. captured_amount: - oneOf: - - type: string - title: captured_amount - description: The payment collection's captured amount. - - type: number - title: captured_amount - description: The payment collection's captured amount. - - type: string - title: captured_amount - description: The payment collection's captured amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: captured_amount + description: The total captured amount of the collection's payments. refunded_amount: - oneOf: - - type: string - title: refunded_amount - description: The payment collection's refunded amount. - - type: number - title: refunded_amount - description: The payment collection's refunded amount. - - type: string - title: refunded_amount - description: The payment collection's refunded amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. completed_at: - oneOf: - - type: string - title: completed_at - description: The payment collection's completed at. - - type: string - title: completed_at - description: The payment collection's completed at. - format: date-time + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -49327,7 +49253,7 @@ components: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: The payment provider used to process the collection's payments and sessions. items: $ref: '#/components/schemas/BasePaymentProvider' payment_sessions: @@ -49342,7 +49268,7 @@ components: $ref: '#/components/schemas/BasePayment' AdminPaymentCollectionResponse: type: object - description: SUMMARY + description: The payment collection's details. x-schemaName: AdminPaymentCollectionResponse required: - payment_collection @@ -49351,11 +49277,23 @@ components: $ref: '#/components/schemas/AdminPaymentCollection' AdminPaymentProvider: type: object - description: The payment provider's payment providers. + description: The payment provider's details. x-schemaName: AdminPaymentProvider + required: + - is_enabled + - id + properties: + id: + type: string + title: id + description: The payment provider's ID. + is_enabled: + type: boolean + title: is_enabled + description: Whether the payment provider is enabled. AdminPaymentResponse: type: object - description: SUMMARY + description: The payment's details. x-schemaName: AdminPaymentResponse required: - payment @@ -49364,42 +49302,42 @@ components: $ref: '#/components/schemas/AdminPayment' AdminPostCancelClaimReqSchema: type: object - description: SUMMARY + description: The details of canceling a claim. x-schemaName: AdminPostCancelClaimReqSchema properties: no_notification: type: boolean title: no_notification - description: The claim's no notification. + description: Whether to send the customer a notification about the claim's cancelation. AdminPostCancelExchangeReqSchema: type: object - description: SUMMARY + description: The details of canceling an exchange. x-schemaName: AdminPostCancelExchangeReqSchema properties: no_notification: type: boolean title: no_notification - description: The exchange's no notification. + description: Whether to send a notification to the customer about the exchange's cancelation. AdminPostCancelReturnReqSchema: type: object - description: SUMMARY + description: The details of canceling a return. x-schemaName: AdminPostCancelReturnReqSchema properties: no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether to send the customer a notification about the return's cancelation. AdminPostClaimItemsReqSchema: type: object - description: SUMMARY + description: The details of the order items to add to the claim. x-schemaName: AdminPostClaimItemsReqSchema properties: items: type: array - description: The claim's items. + description: The item's details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -49407,14 +49345,14 @@ components: id: type: string title: id - description: The item's ID. + description: The ID of the order's item. quantity: type: number title: quantity - description: The item's quantity. + description: The quantity of the order's item to add to the claim. reason: type: string - description: The item's reason. + description: The reason the item is claimed. enum: - missing_item - wrong_item @@ -49427,18 +49365,18 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note that's only viewed by admin users. AdminPostClaimsAddItemsReqSchema: type: object - description: SUMMARY + description: The details of the outbound items to add to the claim. x-schemaName: AdminPostClaimsAddItemsReqSchema properties: items: type: array - description: The claim's items. + description: The outbound item's details. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -49446,11 +49384,11 @@ components: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity - description: The item's quantity. + description: The quantity to send to the customer. unit_price: type: number title: unit_price @@ -49458,46 +49396,46 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. AdminPostClaimsItemsActionReqSchema: type: object - description: SUMMARY + description: The details to update in the item. x-schemaName: AdminPostClaimsItemsActionReqSchema properties: quantity: type: number title: quantity - description: The claim's quantity. + description: The item's quantity. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the return reason associated with the item. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note that's only viewed by admin users. AdminPostClaimsShippingActionReqSchema: type: object - description: SUMMARY + description: The details to update in the shipping method. x-schemaName: AdminPostClaimsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The claim's custom amount. + description: The shipping method's custom amount. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note only viewed by admin users. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. AdminPostClaimsShippingReqSchema: type: object - description: SUMMARY + description: The details of the shipping method used to ship outbound items. x-schemaName: AdminPostClaimsShippingReqSchema required: - shipping_option_id @@ -49505,33 +49443,33 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The claim's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The claim's custom amount. + description: Set a custom price for the shipping method. description: type: string title: description - description: The claim's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note only viewed by admin users. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. AdminPostExchangesAddItemsReqSchema: type: object - description: SUMMARY + description: The details of outbound items. x-schemaName: AdminPostExchangesAddItemsReqSchema properties: items: type: array - description: The exchange's items. + description: The details of outbound items. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -49539,7 +49477,7 @@ components: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity @@ -49551,58 +49489,58 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. allow_backorder: type: boolean title: allow_backorder - description: The item's allow backorder. + description: Whether the item can be added even if it's not in stock. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. AdminPostExchangesItemsActionReqSchema: type: object - description: SUMMARY + description: The details to update in an outbound item. x-schemaName: AdminPostExchangesItemsActionReqSchema properties: quantity: type: number title: quantity - description: The exchange's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note only viewed by admin users. AdminPostExchangesRequestItemsReturnActionReqSchema: type: object - description: SUMMARY + description: The details to update in an inbound (returned) item. x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema properties: quantity: type: number title: quantity - description: The exchange's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The exchange's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. AdminPostExchangesReturnRequestItemsReqSchema: type: object - description: SUMMARY + description: The details of the inbound (return) items. x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema properties: items: type: array - description: The exchange's items. + description: The details of the inbound (return) items. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -49610,7 +49548,7 @@ components: id: type: string title: id - description: The item's ID. + description: The ID of the order's item. quantity: type: number title: quantity @@ -49622,33 +49560,33 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the return reason to associate with the item. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. AdminPostExchangesShippingActionReqSchema: type: object - description: SUMMARY + description: The details of the shipping method to update. x-schemaName: AdminPostExchangesShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: The shipping method's custom amount. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed by admin users only. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. AdminPostExchangesShippingReqSchema: type: object - description: SUMMARY + description: The outbound shipping method's details. x-schemaName: AdminPostExchangesShippingReqSchema required: - shipping_option_id @@ -49656,25 +49594,25 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The exchange's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: Set a custom amount for the shipping method. description: type: string title: description - description: The exchange's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed by admin users only. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. AdminPostOrderClaimsReqSchema: type: object - description: SUMMARY + description: The claim's details. x-schemaName: AdminPostOrderClaimsReqSchema required: - type @@ -49689,7 +49627,7 @@ components: order_id: type: string title: order_id - description: The claim's order id. + description: The ID of the order the claim is created for. description: type: string title: description @@ -49697,25 +49635,25 @@ components: internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. AdminPostOrderEditsAddItemsReqSchema: type: object - description: SUMMARY + description: The details of items to be edited. x-schemaName: AdminPostOrderEditsAddItemsReqSchema properties: items: type: array - description: The order edit's items. + description: The details of items to be edited. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -49723,7 +49661,7 @@ components: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity @@ -49735,30 +49673,30 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. allow_backorder: type: boolean title: allow_backorder - description: The item's allow backorder. + description: Whether the item can be added even if there's no available invenotory quantity of the variant. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. AdminPostOrderEditsItemsActionReqSchema: type: object - description: SUMMARY + description: The details to update in the item. x-schemaName: AdminPostOrderEditsItemsActionReqSchema properties: quantity: type: number title: quantity - description: The order edit's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. AdminPostOrderEditsReqSchema: type: object - description: SUMMARY + description: The order edit's details. x-schemaName: AdminPostOrderEditsReqSchema required: - order_id @@ -49766,7 +49704,7 @@ components: order_id: type: string title: order_id - description: The order edit's order id. + description: The ID of the order this edit is for. description: type: string title: description @@ -49774,29 +49712,29 @@ components: internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The order edit's metadata, can hold custom key-value pairs. AdminPostOrderEditsShippingActionReqSchema: type: object - description: SUMMARY + description: The shipping method's details. x-schemaName: AdminPostOrderEditsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The order edit's custom amount. + description: Set a custom price for the shipping method. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The order edit's metadata, can hold custom key-value pairs. AdminPostOrderEditsShippingReqSchema: type: object - description: SUMMARY + description: The shipping method's details. x-schemaName: AdminPostOrderEditsShippingReqSchema required: - shipping_option_id @@ -49804,25 +49742,25 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The order edit's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The order edit's custom amount. + description: Set a custom price for the shipping method. description: type: string title: description - description: The order edit's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. AdminPostOrderEditsUpdateItemQuantityReqSchema: type: object - description: SUMMARY + description: The order item's details to update. x-schemaName: AdminPostOrderEditsUpdateItemQuantityReqSchema required: - quantity @@ -49830,14 +49768,14 @@ components: quantity: type: number title: quantity - description: The order edit's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. AdminPostOrderExchangesReqSchema: type: object - description: SUMMARY + description: The exchange's details. x-schemaName: AdminPostOrderExchangesReqSchema required: - order_id @@ -49845,7 +49783,7 @@ components: order_id: type: string title: order_id - description: The exchange's order id. + description: The ID of the order this exchange is created for. description: type: string title: description @@ -49853,72 +49791,72 @@ components: internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. AdminPostReceiveReturnsReqSchema: type: object - description: SUMMARY + description: The return receival details. x-schemaName: AdminPostReceiveReturnsReqSchema properties: internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. description: type: string title: description description: The return's description. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. AdminPostReturnsConfirmRequestReqSchema: type: object - description: SUMMARY + description: The confirmation's details. x-schemaName: AdminPostReturnsConfirmRequestReqSchema properties: no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether to send the customer a notification about the confirmation. AdminPostReturnsDismissItemsActionReqSchema: type: object - description: SUMMARY + description: The details to update of the damaged item. x-schemaName: AdminPostReturnsDismissItemsActionReqSchema properties: quantity: type: number title: quantity - description: The return's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. AdminPostReturnsReceiveItemsActionReqSchema: type: object - description: SUMMARY + description: The details of the received item. x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema properties: quantity: type: number title: quantity - description: The return's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. AdminPostReturnsReceiveItemsReqSchema: type: object - description: SUMMARY + description: The items details. x-schemaName: AdminPostReturnsReceiveItemsReqSchema properties: items: type: array - description: The return's items. + description: The items details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -49926,7 +49864,7 @@ components: id: type: string title: id - description: The item's ID. + description: The ID of the item in the order. quantity: type: number title: quantity @@ -49938,10 +49876,10 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. AdminPostReturnsReqSchema: type: object - description: SUMMARY + description: The return's details. x-schemaName: AdminPostReturnsReqSchema required: - order_id @@ -49949,11 +49887,11 @@ components: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order the return belongs to. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location the items are returned to. description: type: string title: description @@ -49961,45 +49899,45 @@ components: internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether to send the customer a notification about the created return. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. AdminPostReturnsRequestItemsActionReqSchema: type: object - description: SUMMARY + description: The details to update in the item. x-schemaName: AdminPostReturnsRequestItemsActionReqSchema properties: quantity: type: number title: quantity - description: The claim's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. AdminPostReturnsRequestItemsReqSchema: type: object - description: SUMMARY + description: The items' details. x-schemaName: AdminPostReturnsRequestItemsReqSchema properties: items: type: array - description: The claim's items. + description: The items' details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -50019,49 +49957,49 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. AdminPostReturnsReturnReqSchema: type: object - description: SUMMARY + description: The return's details. x-schemaName: AdminPostReturnsReturnReqSchema properties: location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location to return items to. no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether the customer should receive notifications about updates to the return. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. AdminPostReturnsShippingActionReqSchema: type: object - description: SUMMARY + description: The shipping method's details. x-schemaName: AdminPostReturnsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The return's custom amount. + description: Set a custom price for the shipping method. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. AdminPostReturnsShippingReqSchema: type: object - description: SUMMARY + description: The shipping method's details. x-schemaName: AdminPostReturnsShippingReqSchema required: - shipping_option_id @@ -50069,25 +50007,25 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The exchange's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: Set the price of the shipping method. description: type: string title: description - description: The exchange's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. AdminPrice: type: object - description: The price's prices. + description: The price's details. x-schemaName: AdminPrice required: - id @@ -50114,6 +50052,7 @@ components: type: string title: currency_code description: The price's currency code. + example: usd amount: type: number title: amount @@ -50124,30 +50063,30 @@ components: min_quantity: type: number title: min_quantity - description: The price's min quantity. + description: The minimum quantity that must be available in the cart for the price to be applied. max_quantity: type: number title: max_quantity - description: The price's max quantity. + description: The maximum quantity allowed to be available in the cart for the price to be applied. price_set_id: type: string title: price_set_id - description: The price's price set id. + description: The ID of the associated price set. created_at: type: string format: date-time title: created_at - description: The price's created at. + description: The date the price was created. updated_at: type: string format: date-time title: updated_at - description: The price's updated at. + description: The date the price was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price's deleted at. + description: The date the price was deleted. AdminPriceList: type: object description: The price list's details. @@ -50184,11 +50123,11 @@ components: starts_at: type: string title: starts_at - description: The price list's starts at. + description: The date the price list starts. ends_at: type: string title: ends_at - description: The price list's ends at. + description: The date the price list ends. status: type: string description: The price list's status. @@ -50210,20 +50149,20 @@ components: type: string format: date-time title: created_at - description: The price list's created at. + description: The date the price list was created. updated_at: type: string format: date-time title: updated_at - description: The price list's updated at. + description: The date the price list was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price list's deleted at. + description: The date the price list was deleted. AdminPriceListBatchResponse: type: object - description: SUMMARY + description: The details of the created, updated, and deleted prices in a price list. x-schemaName: AdminPriceListBatchResponse required: - created @@ -50232,17 +50171,17 @@ components: properties: created: type: array - description: The price list's created. + description: The created prices. items: $ref: '#/components/schemas/AdminPrice' updated: type: array - description: The price list's updated. + description: The updated prices. items: $ref: '#/components/schemas/AdminPrice' deleted: type: object - description: SUMMARY + description: The details of the deleted prices. required: - ids - object @@ -50250,22 +50189,23 @@ components: properties: ids: type: array - description: The deleted's ids. + description: The IDs of the deleted prices. items: type: string title: ids - description: The id's ids. + description: A price's ID. object: type: string title: object - description: SUMMARY + description: The name of the deleted object. + default: price deleted: type: boolean title: deleted - description: SUMMARY + description: Whether the prices were deleted. AdminPriceListDeleteResponse: type: object - description: SUMMARY + description: The details of the deleted price list. x-schemaName: AdminPriceListDeleteResponse required: - id @@ -50284,10 +50224,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Price List was deleted. + description: Whether the price list was deleted. AdminPriceListListResponse: type: object - description: SUMMARY + description: The paginated list of price lists. x-schemaName: AdminPriceListListResponse required: - limit @@ -50298,23 +50238,23 @@ components: limit: type: number title: limit - description: The price list's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The price list's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The price list's count. + description: The total number of items. price_lists: type: array - description: The price list's price lists. + description: The list of price lists. items: $ref: '#/components/schemas/AdminPriceList' AdminPriceListPrice: type: object - description: The price's prices. + description: The details of a price list's price. x-schemaName: AdminPriceListPrice required: - variant_id @@ -50334,7 +50274,7 @@ components: variant_id: type: string title: variant_id - description: The price's variant id. + description: The ID of the product variant this price list is for. rules: type: object description: The price's rules. @@ -50350,6 +50290,7 @@ components: type: string title: currency_code description: The price's currency code. + example: usd amount: type: number title: amount @@ -50360,33 +50301,33 @@ components: min_quantity: type: number title: min_quantity - description: The price's min quantity. + description: The minimum quantity that must be available in the cart for the price to be applied. max_quantity: type: number title: max_quantity - description: The price's max quantity. + description: The maximum quantity allowed to be available in the cart for the price to be applied. price_set_id: type: string title: price_set_id - description: The price's price set id. + description: The ID of the price set this price belongs to. created_at: type: string format: date-time title: created_at - description: The price's created at. + description: The date the price was created. updated_at: type: string format: date-time title: updated_at - description: The price's updated at. + description: The date the price was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price's deleted at. + description: The date the price was deleted. AdminPriceListResponse: type: object - description: SUMMARY + description: The price list's details. x-schemaName: AdminPriceListResponse required: - price_list @@ -50414,32 +50355,34 @@ components: type: string title: attribute description: The price preference's attribute. + example: region_id value: type: string title: value description: The price preference's value. + example: reg_123 is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The price preference's is tax inclusive. + description: Whether prices matching this preference include taxes. created_at: type: string format: date-time title: created_at - description: The price preference's created at. + description: The date the price preference was created. updated_at: type: string format: date-time title: updated_at - description: The price preference's updated at. + description: The date the price preference was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price preference's deleted at. + description: The date the price preference was deleted. AdminPricePreferenceDeleteResponse: type: object - description: SUMMARY + description: The details of the deleted price preference. x-schemaName: AdminPricePreferenceDeleteResponse required: - id @@ -50458,10 +50401,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Price Preference was deleted. + description: Whether the price preference was deleted. AdminPricePreferenceListResponse: type: object - description: SUMMARY + description: The paginated list of price preferences. x-schemaName: AdminPricePreferenceListResponse required: - limit @@ -50472,23 +50415,23 @@ components: limit: type: number title: limit - description: The price preference's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The price preference's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The price preference's count. + description: The total count of items. price_preferences: type: array - description: The price preference's price preferences. + description: The list of price preferences. items: $ref: '#/components/schemas/AdminPricePreference' AdminPricePreferenceResponse: type: object - description: SUMMARY + description: The price preference's details. x-schemaName: AdminPricePreferenceResponse required: - price_preference @@ -50497,7 +50440,7 @@ components: $ref: '#/components/schemas/AdminPricePreference' AdminProduct: type: object - description: The product's parent. + description: The product's details. x-schemaName: AdminProduct required: - type @@ -50531,37 +50474,37 @@ components: $ref: '#/components/schemas/AdminCollection' categories: type: array - description: The parent's categories. + description: The product's categories. items: $ref: '#/components/schemas/AdminProductCategory' sales_channels: type: array - description: The parent's sales channels. + description: The sales channels that the product is available in. items: $ref: '#/components/schemas/AdminSalesChannel' variants: type: array - description: The parent's variants. + description: The product's variants. items: $ref: '#/components/schemas/AdminProductVariant' type: $ref: '#/components/schemas/AdminProductType' tags: type: array - description: The parent's tags. + description: The product's tags. items: $ref: '#/components/schemas/AdminProductTag' length: type: number title: length - description: The parent's length. + description: The product's length. title: type: string title: title - description: The parent's title. + description: The product's title. status: type: string - description: The parent's status. + description: The product's status. enum: - draft - proposed @@ -50569,103 +50512,103 @@ components: - rejected options: type: array - description: The parent's options. + description: The product's options. items: $ref: '#/components/schemas/BaseProductOption' description: type: string title: description - description: The parent's description. + description: The product's description. id: type: string title: id - description: The parent's ID. + description: The product's ID. metadata: type: object - description: The parent's metadata. + description: The product's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the product was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the product was updated. handle: type: string title: handle - description: The parent's handle. + description: The product's unique handle. subtitle: type: string title: subtitle - description: The parent's subtitle. + description: The product's subtitle. is_giftcard: type: boolean title: is_giftcard - description: The parent's is giftcard. + description: Whether the product is a gift card. thumbnail: type: string title: thumbnail - description: The parent's thumbnail. + description: The product's thumbnail. width: type: number title: width - description: The parent's width. + description: The product's width. weight: type: number title: weight - description: The parent's weight. + description: The product's weight. height: type: number title: height - description: The parent's height. + description: The product's height. origin_country: type: string title: origin_country - description: The parent's origin country. + description: The product's origin country. hs_code: type: string title: hs_code - description: The parent's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The parent's mid code. + description: The product's MID code. material: type: string title: material - description: The parent's material. + description: The product's material. collection_id: type: string title: collection_id - description: The parent's collection id. + description: The ID of the collection that the product belongs to. type_id: type: string title: type_id - description: The parent's type id. + description: The ID of the product's type. images: type: array - description: The parent's images. + description: The product's images. items: $ref: '#/components/schemas/BaseProductImage' discountable: type: boolean title: discountable - description: The parent's discountable. + description: Whether discounts can be applied on the product. external_id: type: string title: external_id - description: The parent's external id. + description: The ID of a product in an external system, such as an ERP or CMS. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the product was deleted. AdminProductCategory: type: object - description: The category's categories. + description: The product category's details. x-schemaName: AdminProductCategory required: - category_children @@ -50684,7 +50627,7 @@ components: properties: category_children: type: array - description: The category's category children. + description: The category's children. items: type: object parent_category: @@ -50708,45 +50651,45 @@ components: description: The category's ID. metadata: type: object - description: The category's metadata. + description: The category's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The category's created at. + description: The date the category was created. updated_at: type: string format: date-time title: updated_at - description: The category's updated at. + description: The date the category was updated. handle: type: string title: handle - description: The category's handle. + description: The category's unique handle. deleted_at: type: string format: date-time title: deleted_at - description: The category's deleted at. + description: The date the category was deleted. is_active: type: boolean title: is_active - description: The category's is active. + description: Whether the category is active. If disabled, the category isn't shown in the storefront. is_internal: type: boolean title: is_internal - description: The category's is internal. + description: Whether the category is internal. If enabled, the category is only seen by admin users. rank: type: number title: rank - description: The category's rank. + description: The category's rank among sibling categories. parent_category_id: type: string title: parent_category_id - description: The category's parent category id. + description: The ID of the category's parent. AdminProductCategoryDeleteResponse: type: object - description: SUMMARY + description: The details of deleting the category. x-schemaName: AdminProductCategoryDeleteResponse required: - id @@ -50765,10 +50708,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Product Category was deleted. + description: Whether the product category was deleted. AdminProductCategoryListResponse: type: object - description: SUMMARY + description: The paginated list of product categories. x-schemaName: AdminProductCategoryListResponse required: - limit @@ -50779,23 +50722,23 @@ components: limit: type: number title: limit - description: The product category's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product category's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product category's count. + description: The total number of items. product_categories: type: array - description: The product category's product categories. + description: The list of product categories. items: $ref: '#/components/schemas/AdminProductCategory' AdminProductCategoryResponse: type: object - description: SUMMARY + description: The product category's details. x-schemaName: AdminProductCategoryResponse required: - product_category @@ -50804,7 +50747,7 @@ components: $ref: '#/components/schemas/AdminProductCategory' AdminProductDeleteResponse: type: object - description: SUMMARY + description: The details of the product deletion. x-schemaName: AdminProductDeleteResponse required: - id @@ -50823,7 +50766,7 @@ components: deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product was deleted. AdminProductOption: type: object description: The product's product option. diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh index c0942527bf..f56806ef6d 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh @@ -1,7 +1,7 @@ curl -X POST '{backend_url}/store/customers' \ -H 'Authorization: Bearer {token}' \ --H 'Content-Type: application/json' \ --H 'x-publishable-api-key: {your_publishable_api_key}' \ +-H 'Content-Type: application/json' \ \ +-H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "email": "Monserrate.Leannon88@yahoo.com", "company_name": "{value}", diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml index d0f0e88f40..f94371d50e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The preview of an order. x-schemaName: AdminOrderPreviewResponse required: - order diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml index 18e28bbc59..7dbac7fa46 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: An order's details. x-schemaName: AdminOrderResponse required: - order diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml index 1fed4284d0..ccc9891c96 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The order return details. x-schemaName: AdminOrderReturnResponse required: - order diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPayment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPayment.yaml index 2836394d2e..c03bcea935 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPayment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPayment.yaml @@ -12,29 +12,13 @@ properties: title: id description: The payment's ID. amount: - oneOf: - - type: string - title: amount - description: The payment's amount. - - type: number - title: amount - description: The payment's amount. - - type: string - title: amount - description: The payment's amount. - - $ref: ./IBigNumber.yaml + type: number + title: amount + description: The payment's amount. authorized_amount: - oneOf: - - type: string - title: authorized_amount - description: The payment's authorized amount. - - type: number - title: authorized_amount - description: The payment's authorized amount. - - type: string - title: authorized_amount - description: The payment's authorized amount. - - $ref: ./IBigNumber.yaml + type: number + title: authorized_amount + description: The amount authorized of the payment. currency_code: type: string title: currency_code @@ -42,86 +26,65 @@ properties: provider_id: type: string title: provider_id - description: The payment's provider id. + description: The ID of the payment provider used to process this payment. cart_id: type: string title: cart_id - description: The payment's cart id. + description: The ID of the associated cart. order_id: type: string title: order_id - description: The payment's order id. + description: The ID of the associated order. order_edit_id: type: string title: order_edit_id - description: The payment's order edit id. + description: The ID of the associated order edit. customer_id: type: string title: customer_id - description: The payment's customer id. + description: ID of the associated customer. data: type: object - description: The payment's data. + description: The payment's data, useful for processing by the payment provider. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment created_at: type: string format: date-time title: created_at - description: The payment's created at. + description: The date the payment was created. updated_at: type: string format: date-time title: updated_at - description: The payment's updated at. + description: The date the payment was updated. captured_at: - oneOf: - - type: string - title: captured_at - description: The payment's captured at. - - type: string - title: captured_at - description: The payment's captured at. - format: date-time + type: string + format: date-time + title: captured_at + description: The date the payment was captured. canceled_at: - oneOf: - - type: string - title: canceled_at - description: The payment's canceled at. - - type: string - title: canceled_at - description: The payment's canceled at. - format: date-time + type: string + format: date-time + title: canceled_at + description: The date the payment was canceled. captured_amount: - oneOf: - - type: string - title: captured_amount - description: The payment's captured amount. - - type: number - title: captured_amount - description: The payment's captured amount. - - type: string - title: captured_amount - description: The payment's captured amount. - - $ref: ./IBigNumber.yaml + type: number + title: captured_amount + description: The captured amount of the payment. refunded_amount: - oneOf: - - type: string - title: refunded_amount - description: The payment's refunded amount. - - type: number - title: refunded_amount - description: The payment's refunded amount. - - type: string - title: refunded_amount - description: The payment's refunded amount. - - $ref: ./IBigNumber.yaml + type: number + title: captured_amount + description: The refunded amount of the payment. captures: type: array - description: The payment's captures. + description: The details of payment captures. items: $ref: ./BaseCapture.yaml refunds: type: array - description: The payment's refunds. + description: The details of payment refunds. items: $ref: ./BaseRefund.yaml payment_collection: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml index 684b9497bb..c6fa1d3cac 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml @@ -1,5 +1,5 @@ type: object -description: The payment collection's payment collections. +description: The payment collection's details. x-schemaName: AdminPaymentCollection required: - id @@ -20,77 +20,41 @@ properties: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. amount: - oneOf: - - type: string - title: amount - description: The payment collection's amount. - - type: number - title: amount - description: The payment collection's amount. - - type: string - title: amount - description: The payment collection's amount. - - $ref: ./IBigNumber.yaml + type: number + title: amount + description: The total amount to be paid. authorized_amount: - oneOf: - - type: string - title: authorized_amount - description: The payment collection's authorized amount. - - type: number - title: authorized_amount - description: The payment collection's authorized amount. - - type: string - title: authorized_amount - description: The payment collection's authorized amount. - - $ref: ./IBigNumber.yaml + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. captured_amount: - oneOf: - - type: string - title: captured_amount - description: The payment collection's captured amount. - - type: number - title: captured_amount - description: The payment collection's captured amount. - - type: string - title: captured_amount - description: The payment collection's captured amount. - - $ref: ./IBigNumber.yaml + type: number + title: captured_amount + description: The total captured amount of the collection's payments. refunded_amount: - oneOf: - - type: string - title: refunded_amount - description: The payment collection's refunded amount. - - type: number - title: refunded_amount - description: The payment collection's refunded amount. - - type: string - title: refunded_amount - description: The payment collection's refunded amount. - - $ref: ./IBigNumber.yaml + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. completed_at: - oneOf: - - type: string - title: completed_at - description: The payment collection's completed at. - - type: string - title: completed_at - description: The payment collection's completed at. - format: date-time + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -102,7 +66,9 @@ properties: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: >- + The payment provider used to process the collection's payments and + sessions. items: $ref: ./BasePaymentProvider.yaml payment_sessions: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollectionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollectionResponse.yaml index ccbf99b8f1..7c352dc4d7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollectionResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollectionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The payment collection's details. x-schemaName: AdminPaymentCollectionResponse required: - payment_collection diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentProvider.yaml index 022e34057b..c9d275092e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentProvider.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentProvider.yaml @@ -1,3 +1,15 @@ type: object -description: The payment provider's payment providers. +description: The payment provider's details. x-schemaName: AdminPaymentProvider +required: + - is_enabled + - id +properties: + id: + type: string + title: id + description: The payment provider's ID. + is_enabled: + type: boolean + title: is_enabled + description: Whether the payment provider is enabled. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentResponse.yaml index ede86ff43a..294330408b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The payment's details. x-schemaName: AdminPaymentResponse required: - payment diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelClaimReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelClaimReqSchema.yaml index 1d3ef97265..6cc0d7e555 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelClaimReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelClaimReqSchema.yaml @@ -1,8 +1,8 @@ type: object -description: SUMMARY +description: The details of canceling a claim. x-schemaName: AdminPostCancelClaimReqSchema properties: no_notification: type: boolean title: no_notification - description: The claim's no notification. + description: Whether to send the customer a notification about the claim's cancelation. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelExchangeReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelExchangeReqSchema.yaml index b73520094e..23b6e49230 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelExchangeReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelExchangeReqSchema.yaml @@ -1,8 +1,10 @@ type: object -description: SUMMARY +description: The details of canceling an exchange. x-schemaName: AdminPostCancelExchangeReqSchema properties: no_notification: type: boolean title: no_notification - description: The exchange's no notification. + description: >- + Whether to send a notification to the customer about the exchange's + cancelation. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml index 68a86d8abf..08c7afb4bb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml @@ -1,8 +1,10 @@ type: object -description: SUMMARY +description: The details of canceling a return. x-schemaName: AdminPostCancelReturnReqSchema properties: no_notification: type: boolean title: no_notification - description: The return's no notification. + description: >- + Whether to send the customer a notification about the return's + cancelation. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml index bd2b3450cc..d1dfd8929f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The details of the order items to add to the claim. x-schemaName: AdminPostClaimItemsReqSchema properties: items: type: array - description: The claim's items. + description: The item's details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -15,14 +15,14 @@ properties: id: type: string title: id - description: The item's ID. + description: The ID of the order's item. quantity: type: number title: quantity - description: The item's quantity. + description: The quantity of the order's item to add to the claim. reason: type: string - description: The item's reason. + description: The reason the item is claimed. enum: - missing_item - wrong_item @@ -35,4 +35,4 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note that's only viewed by admin users. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml index 58910cdc4f..c9ce264412 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The details of the outbound items to add to the claim. x-schemaName: AdminPostClaimsAddItemsReqSchema properties: items: type: array - description: The claim's items. + description: The outbound item's details. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -15,11 +15,11 @@ properties: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity - description: The item's quantity. + description: The quantity to send to the customer. unit_price: type: number title: unit_price @@ -27,7 +27,7 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml index 6ab38aa512..9ce243d228 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml @@ -1,16 +1,16 @@ type: object -description: SUMMARY +description: The details to update in the item. x-schemaName: AdminPostClaimsItemsActionReqSchema properties: quantity: type: number title: quantity - description: The claim's quantity. + description: The item's quantity. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the return reason associated with the item. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note that's only viewed by admin users. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml index 3741c54e3d..8d6fe6cdad 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The details to update in the shipping method. x-schemaName: AdminPostClaimsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The claim's custom amount. + description: The shipping method's custom amount. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note only viewed by admin users. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml index 395e129bdd..34e2356020 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the shipping method used to ship outbound items. x-schemaName: AdminPostClaimsShippingReqSchema required: - shipping_option_id @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The claim's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The claim's custom amount. + description: Set a custom price for the shipping method. description: type: string title: description - description: The claim's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note only viewed by admin users. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml index 6609955ffd..bc0234b0bd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The details of outbound items. x-schemaName: AdminPostExchangesAddItemsReqSchema properties: items: type: array - description: The exchange's items. + description: The details of outbound items. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -15,7 +15,7 @@ properties: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity @@ -27,11 +27,11 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. allow_backorder: type: boolean title: allow_backorder - description: The item's allow backorder. + description: Whether the item can be added even if it's not in stock. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml index e48200586c..b751b43bd8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml @@ -1,12 +1,12 @@ type: object -description: SUMMARY +description: The details to update in an outbound item. x-schemaName: AdminPostExchangesItemsActionReqSchema properties: quantity: type: number title: quantity - description: The exchange's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note only viewed by admin users. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml index 1d8aa2b4db..666ccbcfe5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml @@ -1,19 +1,19 @@ type: object -description: SUMMARY +description: The details to update in an inbound (returned) item. x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema properties: quantity: type: number title: quantity - description: The exchange's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The exchange's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml index 3e2045fd89..da3d011473 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The details of the inbound (return) items. x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema properties: items: type: array - description: The exchange's items. + description: The details of the inbound (return) items. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -15,7 +15,7 @@ properties: id: type: string title: id - description: The item's ID. + description: The ID of the order's item. quantity: type: number title: quantity @@ -27,11 +27,11 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the return reason to associate with the item. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml index 68fc3d9b3e..9564ca8aa4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The details of the shipping method to update. x-schemaName: AdminPostExchangesShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: The shipping method's custom amount. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed by admin users only. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml index aee62b6a99..4bff8e27eb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The outbound shipping method's details. x-schemaName: AdminPostExchangesShippingReqSchema required: - shipping_option_id @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The exchange's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: Set a custom amount for the shipping method. description: type: string title: description - description: The exchange's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed by admin users only. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml index 9daa00cb61..e3dc6b300e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The claim's details. x-schemaName: AdminPostOrderClaimsReqSchema required: - type @@ -14,7 +14,7 @@ properties: order_id: type: string title: order_id - description: The claim's order id. + description: The ID of the order the claim is created for. description: type: string title: description @@ -22,11 +22,11 @@ properties: internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml index e1298622f0..5e4fcec7be 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The details of items to be edited. x-schemaName: AdminPostOrderEditsAddItemsReqSchema properties: items: type: array - description: The order edit's items. + description: The details of items to be edited. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -15,7 +15,7 @@ properties: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity @@ -27,11 +27,13 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. allow_backorder: type: boolean title: allow_backorder - description: The item's allow backorder. + description: >- + Whether the item can be added even if there's no available + invenotory quantity of the variant. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml index b366dab18e..ac9348920e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml @@ -1,12 +1,12 @@ type: object -description: SUMMARY +description: The details to update in the item. x-schemaName: AdminPostOrderEditsItemsActionReqSchema properties: quantity: type: number title: quantity - description: The order edit's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml index c6946ef6fe..23a158dae9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The order edit's details. x-schemaName: AdminPostOrderEditsReqSchema required: - order_id @@ -7,7 +7,7 @@ properties: order_id: type: string title: order_id - description: The order edit's order id. + description: The ID of the order this edit is for. description: type: string title: description @@ -15,7 +15,7 @@ properties: internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The order edit's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml index 2e36a37f64..3bad2acc19 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The shipping method's details. x-schemaName: AdminPostOrderEditsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The order edit's custom amount. + description: Set a custom price for the shipping method. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The order edit's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml index cd81378dd5..3327fc1442 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The shipping method's details. x-schemaName: AdminPostOrderEditsShippingReqSchema required: - shipping_option_id @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The order edit's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The order edit's custom amount. + description: Set a custom price for the shipping method. description: type: string title: description - description: The order edit's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml index aab1845f1e..f54ff35e99 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The order item's details to update. x-schemaName: AdminPostOrderEditsUpdateItemQuantityReqSchema required: - quantity @@ -7,8 +7,8 @@ properties: quantity: type: number title: quantity - description: The order edit's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml index 05e3ed3e54..4472a42d37 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The exchange's details. x-schemaName: AdminPostOrderExchangesReqSchema required: - order_id @@ -7,7 +7,7 @@ properties: order_id: type: string title: order_id - description: The exchange's order id. + description: The ID of the order this exchange is created for. description: type: string title: description @@ -15,7 +15,7 @@ properties: internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml index ea798aa3c3..12d20a347b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The return receival details. x-schemaName: AdminPostReceiveReturnsReqSchema properties: internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. description: type: string title: description description: The return's description. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml index b72f231201..afc9e7a3f1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml @@ -1,8 +1,8 @@ type: object -description: SUMMARY +description: The confirmation's details. x-schemaName: AdminPostReturnsConfirmRequestReqSchema properties: no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether to send the customer a notification about the confirmation. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml index d9f9bc3340..a9561ae91f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsDismissItemsActionReqSchema.yaml @@ -1,12 +1,12 @@ type: object -description: SUMMARY +description: The details to update of the damaged item. x-schemaName: AdminPostReturnsDismissItemsActionReqSchema properties: quantity: type: number title: quantity - description: The return's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml index 2b7ac0d973..d9b98ce88a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml @@ -1,12 +1,12 @@ type: object -description: SUMMARY +description: The details of the received item. x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema properties: quantity: type: number title: quantity - description: The return's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml index abb7e8850f..c3e219537a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The items details. x-schemaName: AdminPostReturnsReceiveItemsReqSchema properties: items: type: array - description: The return's items. + description: The items details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -15,7 +15,7 @@ properties: id: type: string title: id - description: The item's ID. + description: The ID of the item in the order. quantity: type: number title: quantity @@ -27,4 +27,4 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml index 68be6f5dcc..0fbd580159 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The return's details. x-schemaName: AdminPostReturnsReqSchema required: - order_id @@ -7,11 +7,11 @@ properties: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order the return belongs to. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location the items are returned to. description: type: string title: description @@ -19,11 +19,11 @@ properties: internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether to send the customer a notification about the created return. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml index eae1e908a0..0d0c6e633c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml @@ -1,19 +1,19 @@ type: object -description: SUMMARY +description: The details to update in the item. x-schemaName: AdminPostReturnsRequestItemsActionReqSchema properties: quantity: type: number title: quantity - description: The claim's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml index 39180c5b5e..d47549d7ef 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml @@ -1,13 +1,13 @@ type: object -description: SUMMARY +description: The items' details. x-schemaName: AdminPostReturnsRequestItemsReqSchema properties: items: type: array - description: The claim's items. + description: The items' details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -27,11 +27,11 @@ properties: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml index 3d5c38d44d..bdb5f9b00d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml @@ -1,15 +1,17 @@ type: object -description: SUMMARY +description: The return's details. x-schemaName: AdminPostReturnsReturnReqSchema properties: location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location to return items to. no_notification: type: boolean title: no_notification - description: The return's no notification. + description: >- + Whether the customer should receive notifications about updates to the + return. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml index 5cd4a15e19..2fb4607a74 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The shipping method's details. x-schemaName: AdminPostReturnsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The return's custom amount. + description: Set a custom price for the shipping method. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml index 9cd63a9d16..861fa03fc7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The shipping method's details. x-schemaName: AdminPostReturnsShippingReqSchema required: - shipping_option_id @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The exchange's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: Set the price of the shipping method. description: type: string title: description - description: The exchange's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPrice.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPrice.yaml index c63019f47d..fa5b3c1698 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPrice.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPrice.yaml @@ -1,5 +1,5 @@ type: object -description: The price's prices. +description: The price's details. x-schemaName: AdminPrice required: - id @@ -26,6 +26,7 @@ properties: type: string title: currency_code description: The price's currency code. + example: usd amount: type: number title: amount @@ -36,27 +37,31 @@ properties: min_quantity: type: number title: min_quantity - description: The price's min quantity. + description: >- + The minimum quantity that must be available in the cart for the price to + be applied. max_quantity: type: number title: max_quantity - description: The price's max quantity. + description: >- + The maximum quantity allowed to be available in the cart for the price to + be applied. price_set_id: type: string title: price_set_id - description: The price's price set id. + description: The ID of the associated price set. created_at: type: string format: date-time title: created_at - description: The price's created at. + description: The date the price was created. updated_at: type: string format: date-time title: updated_at - description: The price's updated at. + description: The date the price was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price's deleted at. + description: The date the price was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml index e921b8aa5f..167aebd053 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml @@ -33,11 +33,11 @@ properties: starts_at: type: string title: starts_at - description: The price list's starts at. + description: The date the price list starts. ends_at: type: string title: ends_at - description: The price list's ends at. + description: The date the price list ends. status: type: string description: The price list's status. @@ -59,14 +59,14 @@ properties: type: string format: date-time title: created_at - description: The price list's created at. + description: The date the price list was created. updated_at: type: string format: date-time title: updated_at - description: The price list's updated at. + description: The date the price list was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price list's deleted at. + description: The date the price list was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml index b4cb20eabd..e862d875b1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the created, updated, and deleted prices in a price list. x-schemaName: AdminPriceListBatchResponse required: - created @@ -8,17 +8,17 @@ required: properties: created: type: array - description: The price list's created. + description: The created prices. items: $ref: ./AdminPrice.yaml updated: type: array - description: The price list's updated. + description: The updated prices. items: $ref: ./AdminPrice.yaml deleted: type: object - description: SUMMARY + description: The details of the deleted prices. required: - ids - object @@ -26,16 +26,17 @@ properties: properties: ids: type: array - description: The deleted's ids. + description: The IDs of the deleted prices. items: type: string title: ids - description: The id's ids. + description: A price's ID. object: type: string title: object - description: SUMMARY + description: The name of the deleted object. + default: price deleted: type: boolean title: deleted - description: SUMMARY + description: Whether the prices were deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml index d7e323c8f9..7daa3cffe5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the deleted price list. x-schemaName: AdminPriceListDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Price List was deleted. + description: Whether the price list was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListListResponse.yaml index 0199ba1e0e..186db813c9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of price lists. x-schemaName: AdminPriceListListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The price list's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The price list's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The price list's count. + description: The total number of items. price_lists: type: array - description: The price list's price lists. + description: The list of price lists. items: $ref: ./AdminPriceList.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListPrice.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListPrice.yaml index 5e699d3feb..b8bf77e63a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListPrice.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListPrice.yaml @@ -1,5 +1,5 @@ type: object -description: The price's prices. +description: The details of a price list's price. x-schemaName: AdminPriceListPrice required: - variant_id @@ -19,7 +19,7 @@ properties: variant_id: type: string title: variant_id - description: The price's variant id. + description: The ID of the product variant this price list is for. rules: type: object description: The price's rules. @@ -35,6 +35,7 @@ properties: type: string title: currency_code description: The price's currency code. + example: usd amount: type: number title: amount @@ -45,27 +46,31 @@ properties: min_quantity: type: number title: min_quantity - description: The price's min quantity. + description: >- + The minimum quantity that must be available in the cart for the price to + be applied. max_quantity: type: number title: max_quantity - description: The price's max quantity. + description: >- + The maximum quantity allowed to be available in the cart for the price to + be applied. price_set_id: type: string title: price_set_id - description: The price's price set id. + description: The ID of the price set this price belongs to. created_at: type: string format: date-time title: created_at - description: The price's created at. + description: The date the price was created. updated_at: type: string format: date-time title: updated_at - description: The price's updated at. + description: The date the price was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price's deleted at. + description: The date the price was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListResponse.yaml index b666517278..13421d2edb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The price list's details. x-schemaName: AdminPriceListResponse required: - price_list diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreference.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreference.yaml index 01479f00c8..7f3fbec642 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreference.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreference.yaml @@ -18,26 +18,28 @@ properties: type: string title: attribute description: The price preference's attribute. + example: region_id value: type: string title: value description: The price preference's value. + example: reg_123 is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The price preference's is tax inclusive. + description: Whether prices matching this preference include taxes. created_at: type: string format: date-time title: created_at - description: The price preference's created at. + description: The date the price preference was created. updated_at: type: string format: date-time title: updated_at - description: The price preference's updated at. + description: The date the price preference was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price preference's deleted at. + description: The date the price preference was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml index 8f38315baa..b7544c2f3f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the deleted price preference. x-schemaName: AdminPricePreferenceDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Price Preference was deleted. + description: Whether the price preference was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceListResponse.yaml index 1ee09e258e..06f53caac6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of price preferences. x-schemaName: AdminPricePreferenceListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The price preference's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The price preference's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The price preference's count. + description: The total count of items. price_preferences: type: array - description: The price preference's price preferences. + description: The list of price preferences. items: $ref: ./AdminPricePreference.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceResponse.yaml index 4fbab75262..8a2ff0a7ab 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The price preference's details. x-schemaName: AdminPricePreferenceResponse required: - price_preference diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml index 3fe71d64f6..f8bf5ad600 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -1,5 +1,5 @@ type: object -description: The product's parent. +description: The product's details. x-schemaName: AdminProduct required: - type @@ -33,37 +33,37 @@ properties: $ref: ./AdminCollection.yaml categories: type: array - description: The parent's categories. + description: The product's categories. items: $ref: ./AdminProductCategory.yaml sales_channels: type: array - description: The parent's sales channels. + description: The sales channels that the product is available in. items: $ref: ./AdminSalesChannel.yaml variants: type: array - description: The parent's variants. + description: The product's variants. items: $ref: ./AdminProductVariant.yaml type: $ref: ./AdminProductType.yaml tags: type: array - description: The parent's tags. + description: The product's tags. items: $ref: ./AdminProductTag.yaml length: type: number title: length - description: The parent's length. + description: The product's length. title: type: string title: title - description: The parent's title. + description: The product's title. status: type: string - description: The parent's status. + description: The product's status. enum: - draft - proposed @@ -71,97 +71,97 @@ properties: - rejected options: type: array - description: The parent's options. + description: The product's options. items: $ref: ./BaseProductOption.yaml description: type: string title: description - description: The parent's description. + description: The product's description. id: type: string title: id - description: The parent's ID. + description: The product's ID. metadata: type: object - description: The parent's metadata. + description: The product's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the product was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the product was updated. handle: type: string title: handle - description: The parent's handle. + description: The product's unique handle. subtitle: type: string title: subtitle - description: The parent's subtitle. + description: The product's subtitle. is_giftcard: type: boolean title: is_giftcard - description: The parent's is giftcard. + description: Whether the product is a gift card. thumbnail: type: string title: thumbnail - description: The parent's thumbnail. + description: The product's thumbnail. width: type: number title: width - description: The parent's width. + description: The product's width. weight: type: number title: weight - description: The parent's weight. + description: The product's weight. height: type: number title: height - description: The parent's height. + description: The product's height. origin_country: type: string title: origin_country - description: The parent's origin country. + description: The product's origin country. hs_code: type: string title: hs_code - description: The parent's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The parent's mid code. + description: The product's MID code. material: type: string title: material - description: The parent's material. + description: The product's material. collection_id: type: string title: collection_id - description: The parent's collection id. + description: The ID of the collection that the product belongs to. type_id: type: string title: type_id - description: The parent's type id. + description: The ID of the product's type. images: type: array - description: The parent's images. + description: The product's images. items: $ref: ./BaseProductImage.yaml discountable: type: boolean title: discountable - description: The parent's discountable. + description: Whether discounts can be applied on the product. external_id: type: string title: external_id - description: The parent's external id. + description: The ID of a product in an external system, such as an ERP or CMS. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the product was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml index 1845f1e5de..3c5286bc34 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml @@ -1,5 +1,5 @@ type: object -description: The category's categories. +description: The product category's details. x-schemaName: AdminProductCategory required: - category_children @@ -18,7 +18,7 @@ required: properties: category_children: type: array - description: The category's category children. + description: The category's children. items: type: object parent_category: @@ -42,39 +42,43 @@ properties: description: The category's ID. metadata: type: object - description: The category's metadata. + description: The category's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The category's created at. + description: The date the category was created. updated_at: type: string format: date-time title: updated_at - description: The category's updated at. + description: The date the category was updated. handle: type: string title: handle - description: The category's handle. + description: The category's unique handle. deleted_at: type: string format: date-time title: deleted_at - description: The category's deleted at. + description: The date the category was deleted. is_active: type: boolean title: is_active - description: The category's is active. + description: >- + Whether the category is active. If disabled, the category isn't shown in + the storefront. is_internal: type: boolean title: is_internal - description: The category's is internal. + description: >- + Whether the category is internal. If enabled, the category is only seen by + admin users. rank: type: number title: rank - description: The category's rank. + description: The category's rank among sibling categories. parent_category_id: type: string title: parent_category_id - description: The category's parent category id. + description: The ID of the category's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml index b2531e9fab..12ce01e8cf 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of deleting the category. x-schemaName: AdminProductCategoryDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Product Category was deleted. + description: Whether the product category was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryListResponse.yaml index 542fca2356..7f0f60468b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of product categories. x-schemaName: AdminProductCategoryListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The product category's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product category's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product category's count. + description: The total number of items. product_categories: type: array - description: The product category's product categories. + description: The list of product categories. items: $ref: ./AdminProductCategory.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryResponse.yaml index b46adcf4e2..eaccc1fb6d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product category's details. x-schemaName: AdminProductCategoryResponse required: - product_category diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml index 8a448dd6a4..f33d992df9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the product deletion. x-schemaName: AdminProductDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product was deleted. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 4a273fb3df..14d4c8a9f4 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -467,7 +467,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl -X POST '{backend_url}/store/carts' + source: |- + curl -X POST '{backend_url}/store/carts' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Carts responses: @@ -522,7 +524,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/carts/{id}' + source: |- + curl '{backend_url}/store/carts/{id}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Carts responses: @@ -588,7 +592,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl -X POST '{backend_url}/store/carts/{id}' + source: |- + curl -X POST '{backend_url}/store/carts/{id}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Carts responses: @@ -652,7 +658,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl -X POST '{backend_url}/store/carts/{id}/complete' + source: |- + curl -X POST '{backend_url}/store/carts/{id}/complete' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Carts responses: @@ -766,7 +774,8 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/store/carts/{id}/line-items' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "variant_id": "{value}", "quantity": 3360689747918848, @@ -843,7 +852,8 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "quantity": 8980402259623936, "metadata": {} @@ -911,7 +921,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl -X DELETE '{backend_url}/store/carts/{id}/line-items/{line_id}' + source: |- + curl -X DELETE '{backend_url}/store/carts/{id}/line-items/{line_id}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Carts responses: @@ -1012,7 +1024,8 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/store/carts/{id}/promotions' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "promo_codes": [ "{value}" @@ -1071,7 +1084,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl -X DELETE '{backend_url}/store/carts/{id}/promotions' + source: |- + curl -X DELETE '{backend_url}/store/carts/{id}/promotions' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Carts responses: @@ -1157,7 +1172,8 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "option_id": "{value}" }' @@ -1221,7 +1237,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl -X POST '{backend_url}/store/carts/{id}/taxes' + source: |- + curl -X POST '{backend_url}/store/carts/{id}/taxes' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Carts responses: @@ -2046,7 +2064,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/collections' + source: |- + curl '{backend_url}/store/collections' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Collections responses: @@ -2132,7 +2152,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/collections/{id}' + source: |- + curl '{backend_url}/store/collections/{id}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Collections responses: @@ -2246,7 +2268,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/currencies' + source: |- + curl '{backend_url}/store/currencies' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Currencies responses: @@ -2300,7 +2324,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/currencies/{code}' + source: |- + curl '{backend_url}/store/currencies/{code}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Currencies responses: @@ -2359,7 +2385,8 @@ paths: source: |- curl -X POST '{backend_url}/store/customers' \ -H 'Authorization: Bearer {token}' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "email": "Monserrate.Leannon88@yahoo.com", "company_name": "{value}", @@ -2424,7 +2451,8 @@ paths: label: cURL source: |- curl '{backend_url}/store/customers/me' \ - -H 'Authorization: Bearer {access_token}' + -H 'Authorization: Bearer {access_token}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Customers responses: @@ -2485,7 +2513,8 @@ paths: source: |- curl -X POST '{backend_url}/store/customers/me' \ -H 'Authorization: Bearer {access_token}' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "company_name": "{value}", "first_name": "{value}", @@ -2605,7 +2634,8 @@ paths: label: cURL source: |- curl '{backend_url}/store/customers/me/addresses' \ - -H 'Authorization: Bearer {access_token}' + -H 'Authorization: Bearer {access_token}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Customers responses: @@ -2724,7 +2754,8 @@ paths: source: |- curl -X POST '{backend_url}/store/customers/me/addresses' \ -H 'Authorization: Bearer {access_token}' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "metadata": {}, "first_name": "{value}", @@ -2799,7 +2830,8 @@ paths: label: cURL source: |- curl '{backend_url}/store/customers/me/addresses/{address_id}' \ - -H 'Authorization: Bearer {access_token}' + -H 'Authorization: Bearer {access_token}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Customers responses: @@ -2924,7 +2956,8 @@ paths: source: |- curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \ -H 'Authorization: Bearer {access_token}' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "first_name": "{value}", }' @@ -2989,7 +3022,8 @@ paths: - lang: Shell label: cURL source: |- - curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ + curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' -H 'Authorization: Bearer {access_token}' tags: - Customers @@ -3158,7 +3192,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/orders' + source: |- + curl '{backend_url}/store/orders' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Orders responses: @@ -3244,7 +3280,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/orders/{id}' + source: |- + curl '{backend_url}/store/orders/{id}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Orders responses: @@ -3302,7 +3340,8 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/store/payment-collections' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "cart_id": "{value}", "region_id": "{value}", @@ -3392,7 +3431,8 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "provider_id": "{value}" }' @@ -3479,7 +3519,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/payment-providers' + source: |- + curl '{backend_url}/store/payment-providers' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Payment Providers responses: @@ -4388,7 +4430,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/product-categories' + source: |- + curl '{backend_url}/store/product-categories' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Product Categories responses: @@ -4461,7 +4505,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/product-categories/{id}' + source: |- + curl '{backend_url}/store/product-categories/{id}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Product Categories responses: @@ -5415,7 +5461,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/products' + source: |- + curl '{backend_url}/store/products' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Products responses: @@ -5536,7 +5584,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/products/{id}' + source: |- + curl '{backend_url}/store/products/{id}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Products responses: @@ -5681,7 +5731,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/regions' + source: |- + curl '{backend_url}/store/regions' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Regions responses: @@ -5808,7 +5860,8 @@ paths: label: cURL source: |- curl -X POST '{backend_url}/store/return' \ - -H 'Content-Type: application/json' \ + -H 'Content-Type: application/json' \ \ + -H 'x-publishable-api-key: {your_publishable_api_key}' --data-raw '{ "order_id": "{value}", "items": [ @@ -5898,7 +5951,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/return-reasons' + source: |- + curl '{backend_url}/store/return-reasons' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Return Reasons responses: @@ -5981,7 +6036,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/return-reasons/{id}' + source: |- + curl '{backend_url}/store/return-reasons/{id}' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Return Reasons responses: @@ -6079,7 +6136,9 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/shipping-options' + source: |- + curl '{backend_url}/store/shipping-options' \ + -H 'x-publishable-api-key: {your_publishable_api_key}' tags: - Shipping Options responses: @@ -11263,7 +11322,7 @@ components: $ref: '#/components/schemas/AdminSalesChannel' AdminOrderPreviewResponse: type: object - description: SUMMARY + description: The preview of an order. x-schemaName: AdminOrderPreviewResponse required: - order @@ -11272,7 +11331,7 @@ components: $ref: '#/components/schemas/AdminOrderPreview' AdminOrderResponse: type: object - description: SUMMARY + description: An order's details. x-schemaName: AdminOrderResponse required: - order @@ -11281,7 +11340,7 @@ components: $ref: '#/components/schemas/AdminOrder' AdminOrderReturnResponse: type: object - description: SUMMARY + description: The order return details. x-schemaName: AdminOrderReturnResponse required: - order @@ -11306,29 +11365,13 @@ components: title: id description: The payment's ID. amount: - oneOf: - - type: string - title: amount - description: The payment's amount. - - type: number - title: amount - description: The payment's amount. - - type: string - title: amount - description: The payment's amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: amount + description: The payment's amount. authorized_amount: - oneOf: - - type: string - title: authorized_amount - description: The payment's authorized amount. - - type: number - title: authorized_amount - description: The payment's authorized amount. - - type: string - title: authorized_amount - description: The payment's authorized amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: authorized_amount + description: The amount authorized of the payment. currency_code: type: string title: currency_code @@ -11336,86 +11379,64 @@ components: provider_id: type: string title: provider_id - description: The payment's provider id. + description: The ID of the payment provider used to process this payment. cart_id: type: string title: cart_id - description: The payment's cart id. + description: The ID of the associated cart. order_id: type: string title: order_id - description: The payment's order id. + description: The ID of the associated order. order_edit_id: type: string title: order_edit_id - description: The payment's order edit id. + description: The ID of the associated order edit. customer_id: type: string title: customer_id - description: The payment's customer id. + description: ID of the associated customer. data: type: object - description: The payment's data. + description: The payment's data, useful for processing by the payment provider. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment created_at: type: string format: date-time title: created_at - description: The payment's created at. + description: The date the payment was created. updated_at: type: string format: date-time title: updated_at - description: The payment's updated at. + description: The date the payment was updated. captured_at: - oneOf: - - type: string - title: captured_at - description: The payment's captured at. - - type: string - title: captured_at - description: The payment's captured at. - format: date-time + type: string + format: date-time + title: captured_at + description: The date the payment was captured. canceled_at: - oneOf: - - type: string - title: canceled_at - description: The payment's canceled at. - - type: string - title: canceled_at - description: The payment's canceled at. - format: date-time + type: string + format: date-time + title: canceled_at + description: The date the payment was canceled. captured_amount: - oneOf: - - type: string - title: captured_amount - description: The payment's captured amount. - - type: number - title: captured_amount - description: The payment's captured amount. - - type: string - title: captured_amount - description: The payment's captured amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: captured_amount + description: The captured amount of the payment. refunded_amount: - oneOf: - - type: string - title: refunded_amount - description: The payment's refunded amount. - - type: number - title: refunded_amount - description: The payment's refunded amount. - - type: string - title: refunded_amount - description: The payment's refunded amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: captured_amount + description: The refunded amount of the payment. captures: type: array - description: The payment's captures. + description: The details of payment captures. items: $ref: '#/components/schemas/BaseCapture' refunds: type: array - description: The payment's refunds. + description: The details of payment refunds. items: $ref: '#/components/schemas/BaseRefund' payment_collection: @@ -11424,7 +11445,7 @@ components: $ref: '#/components/schemas/BasePaymentSession' AdminPaymentCollection: type: object - description: The payment collection's payment collections. + description: The payment collection's details. x-schemaName: AdminPaymentCollection required: - id @@ -11445,77 +11466,41 @@ components: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. amount: - oneOf: - - type: string - title: amount - description: The payment collection's amount. - - type: number - title: amount - description: The payment collection's amount. - - type: string - title: amount - description: The payment collection's amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: amount + description: The total amount to be paid. authorized_amount: - oneOf: - - type: string - title: authorized_amount - description: The payment collection's authorized amount. - - type: number - title: authorized_amount - description: The payment collection's authorized amount. - - type: string - title: authorized_amount - description: The payment collection's authorized amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. captured_amount: - oneOf: - - type: string - title: captured_amount - description: The payment collection's captured amount. - - type: number - title: captured_amount - description: The payment collection's captured amount. - - type: string - title: captured_amount - description: The payment collection's captured amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: captured_amount + description: The total captured amount of the collection's payments. refunded_amount: - oneOf: - - type: string - title: refunded_amount - description: The payment collection's refunded amount. - - type: number - title: refunded_amount - description: The payment collection's refunded amount. - - type: string - title: refunded_amount - description: The payment collection's refunded amount. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. completed_at: - oneOf: - - type: string - title: completed_at - description: The payment collection's completed at. - - type: string - title: completed_at - description: The payment collection's completed at. - format: date-time + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -11527,7 +11512,7 @@ components: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: The payment provider used to process the collection's payments and sessions. items: $ref: '#/components/schemas/BasePaymentProvider' payment_sessions: @@ -11542,7 +11527,7 @@ components: $ref: '#/components/schemas/BasePayment' AdminPaymentCollectionResponse: type: object - description: SUMMARY + description: The payment collection's details. x-schemaName: AdminPaymentCollectionResponse required: - payment_collection @@ -11551,11 +11536,23 @@ components: $ref: '#/components/schemas/AdminPaymentCollection' AdminPaymentProvider: type: object - description: The payment provider's payment providers. + description: The payment provider's details. x-schemaName: AdminPaymentProvider + required: + - is_enabled + - id + properties: + id: + type: string + title: id + description: The payment provider's ID. + is_enabled: + type: boolean + title: is_enabled + description: Whether the payment provider is enabled. AdminPaymentResponse: type: object - description: SUMMARY + description: The payment's details. x-schemaName: AdminPaymentResponse required: - payment @@ -11564,42 +11561,42 @@ components: $ref: '#/components/schemas/AdminPayment' AdminPostCancelClaimReqSchema: type: object - description: SUMMARY + description: The details of canceling a claim. x-schemaName: AdminPostCancelClaimReqSchema properties: no_notification: type: boolean title: no_notification - description: The claim's no notification. + description: Whether to send the customer a notification about the claim's cancelation. AdminPostCancelExchangeReqSchema: type: object - description: SUMMARY + description: The details of canceling an exchange. x-schemaName: AdminPostCancelExchangeReqSchema properties: no_notification: type: boolean title: no_notification - description: The exchange's no notification. + description: Whether to send a notification to the customer about the exchange's cancelation. AdminPostCancelReturnReqSchema: type: object - description: SUMMARY + description: The details of canceling a return. x-schemaName: AdminPostCancelReturnReqSchema properties: no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether to send the customer a notification about the return's cancelation. AdminPostClaimItemsReqSchema: type: object - description: SUMMARY + description: The details of the order items to add to the claim. x-schemaName: AdminPostClaimItemsReqSchema properties: items: type: array - description: The claim's items. + description: The item's details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -11607,14 +11604,14 @@ components: id: type: string title: id - description: The item's ID. + description: The ID of the order's item. quantity: type: number title: quantity - description: The item's quantity. + description: The quantity of the order's item to add to the claim. reason: type: string - description: The item's reason. + description: The reason the item is claimed. enum: - missing_item - wrong_item @@ -11627,18 +11624,18 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note that's only viewed by admin users. AdminPostClaimsAddItemsReqSchema: type: object - description: SUMMARY + description: The details of the outbound items to add to the claim. x-schemaName: AdminPostClaimsAddItemsReqSchema properties: items: type: array - description: The claim's items. + description: The outbound item's details. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -11646,11 +11643,11 @@ components: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity - description: The item's quantity. + description: The quantity to send to the customer. unit_price: type: number title: unit_price @@ -11658,46 +11655,46 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. AdminPostClaimsItemsActionReqSchema: type: object - description: SUMMARY + description: The details to update in the item. x-schemaName: AdminPostClaimsItemsActionReqSchema properties: quantity: type: number title: quantity - description: The claim's quantity. + description: The item's quantity. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the return reason associated with the item. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note that's only viewed by admin users. AdminPostClaimsShippingActionReqSchema: type: object - description: SUMMARY + description: The details to update in the shipping method. x-schemaName: AdminPostClaimsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The claim's custom amount. + description: The shipping method's custom amount. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note only viewed by admin users. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. AdminPostClaimsShippingReqSchema: type: object - description: SUMMARY + description: The details of the shipping method used to ship outbound items. x-schemaName: AdminPostClaimsShippingReqSchema required: - shipping_option_id @@ -11705,33 +11702,33 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The claim's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The claim's custom amount. + description: Set a custom price for the shipping method. description: type: string title: description - description: The claim's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note only viewed by admin users. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. AdminPostExchangesAddItemsReqSchema: type: object - description: SUMMARY + description: The details of outbound items. x-schemaName: AdminPostExchangesAddItemsReqSchema properties: items: type: array - description: The exchange's items. + description: The details of outbound items. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -11739,7 +11736,7 @@ components: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity @@ -11751,58 +11748,58 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. allow_backorder: type: boolean title: allow_backorder - description: The item's allow backorder. + description: Whether the item can be added even if it's not in stock. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. AdminPostExchangesItemsActionReqSchema: type: object - description: SUMMARY + description: The details to update in an outbound item. x-schemaName: AdminPostExchangesItemsActionReqSchema properties: quantity: type: number title: quantity - description: The exchange's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note only viewed by admin users. AdminPostExchangesRequestItemsReturnActionReqSchema: type: object - description: SUMMARY + description: The details to update in an inbound (returned) item. x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema properties: quantity: type: number title: quantity - description: The exchange's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The exchange's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. AdminPostExchangesReturnRequestItemsReqSchema: type: object - description: SUMMARY + description: The details of the inbound (return) items. x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema properties: items: type: array - description: The exchange's items. + description: The details of the inbound (return) items. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -11810,7 +11807,7 @@ components: id: type: string title: id - description: The item's ID. + description: The ID of the order's item. quantity: type: number title: quantity @@ -11822,33 +11819,33 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the return reason to associate with the item. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. AdminPostExchangesShippingActionReqSchema: type: object - description: SUMMARY + description: The details of the shipping method to update. x-schemaName: AdminPostExchangesShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: The shipping method's custom amount. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed by admin users only. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. AdminPostExchangesShippingReqSchema: type: object - description: SUMMARY + description: The outbound shipping method's details. x-schemaName: AdminPostExchangesShippingReqSchema required: - shipping_option_id @@ -11856,25 +11853,25 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The exchange's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: Set a custom amount for the shipping method. description: type: string title: description - description: The exchange's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed by admin users only. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. AdminPostOrderClaimsReqSchema: type: object - description: SUMMARY + description: The claim's details. x-schemaName: AdminPostOrderClaimsReqSchema required: - type @@ -11889,7 +11886,7 @@ components: order_id: type: string title: order_id - description: The claim's order id. + description: The ID of the order the claim is created for. description: type: string title: description @@ -11897,25 +11894,25 @@ components: internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. AdminPostOrderEditsAddItemsReqSchema: type: object - description: SUMMARY + description: The details of items to be edited. x-schemaName: AdminPostOrderEditsAddItemsReqSchema properties: items: type: array - description: The order edit's items. + description: The details of items to be edited. items: type: object - description: The item's items. + description: An item's details. required: - variant_id - quantity @@ -11923,7 +11920,7 @@ components: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. quantity: type: number title: quantity @@ -11935,30 +11932,30 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. allow_backorder: type: boolean title: allow_backorder - description: The item's allow backorder. + description: Whether the item can be added even if there's no available invenotory quantity of the variant. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. AdminPostOrderEditsItemsActionReqSchema: type: object - description: SUMMARY + description: The details to update in the item. x-schemaName: AdminPostOrderEditsItemsActionReqSchema properties: quantity: type: number title: quantity - description: The order edit's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. AdminPostOrderEditsReqSchema: type: object - description: SUMMARY + description: The order edit's details. x-schemaName: AdminPostOrderEditsReqSchema required: - order_id @@ -11966,7 +11963,7 @@ components: order_id: type: string title: order_id - description: The order edit's order id. + description: The ID of the order this edit is for. description: type: string title: description @@ -11974,29 +11971,29 @@ components: internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The order edit's metadata, can hold custom key-value pairs. AdminPostOrderEditsShippingActionReqSchema: type: object - description: SUMMARY + description: The shipping method's details. x-schemaName: AdminPostOrderEditsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The order edit's custom amount. + description: Set a custom price for the shipping method. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The order edit's metadata, can hold custom key-value pairs. AdminPostOrderEditsShippingReqSchema: type: object - description: SUMMARY + description: The shipping method's details. x-schemaName: AdminPostOrderEditsShippingReqSchema required: - shipping_option_id @@ -12004,25 +12001,25 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The order edit's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The order edit's custom amount. + description: Set a custom price for the shipping method. description: type: string title: description - description: The order edit's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The order edit's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. AdminPostOrderEditsUpdateItemQuantityReqSchema: type: object - description: SUMMARY + description: The order item's details to update. x-schemaName: AdminPostOrderEditsUpdateItemQuantityReqSchema required: - quantity @@ -12030,14 +12027,14 @@ components: quantity: type: number title: quantity - description: The order edit's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The order edit's internal note. + description: A note viewed only by admin users. AdminPostOrderExchangesReqSchema: type: object - description: SUMMARY + description: The exchange's details. x-schemaName: AdminPostOrderExchangesReqSchema required: - order_id @@ -12045,7 +12042,7 @@ components: order_id: type: string title: order_id - description: The exchange's order id. + description: The ID of the order this exchange is created for. description: type: string title: description @@ -12053,72 +12050,72 @@ components: internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. AdminPostReceiveReturnsReqSchema: type: object - description: SUMMARY + description: The return receival details. x-schemaName: AdminPostReceiveReturnsReqSchema properties: internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. description: type: string title: description description: The return's description. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. AdminPostReturnsConfirmRequestReqSchema: type: object - description: SUMMARY + description: The confirmation's details. x-schemaName: AdminPostReturnsConfirmRequestReqSchema properties: no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether to send the customer a notification about the confirmation. AdminPostReturnsDismissItemsActionReqSchema: type: object - description: SUMMARY + description: The details to update of the damaged item. x-schemaName: AdminPostReturnsDismissItemsActionReqSchema properties: quantity: type: number title: quantity - description: The return's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. AdminPostReturnsReceiveItemsActionReqSchema: type: object - description: SUMMARY + description: The details of the received item. x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema properties: quantity: type: number title: quantity - description: The return's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. AdminPostReturnsReceiveItemsReqSchema: type: object - description: SUMMARY + description: The items details. x-schemaName: AdminPostReturnsReceiveItemsReqSchema properties: items: type: array - description: The return's items. + description: The items details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -12126,7 +12123,7 @@ components: id: type: string title: id - description: The item's ID. + description: The ID of the item in the order. quantity: type: number title: quantity @@ -12138,10 +12135,10 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. AdminPostReturnsReqSchema: type: object - description: SUMMARY + description: The return's details. x-schemaName: AdminPostReturnsReqSchema required: - order_id @@ -12149,11 +12146,11 @@ components: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order the return belongs to. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location the items are returned to. description: type: string title: description @@ -12161,45 +12158,45 @@ components: internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether to send the customer a notification about the created return. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. AdminPostReturnsRequestItemsActionReqSchema: type: object - description: SUMMARY + description: The details to update in the item. x-schemaName: AdminPostReturnsRequestItemsActionReqSchema properties: quantity: type: number title: quantity - description: The claim's quantity. + description: The item's quantity. internal_note: type: string title: internal_note - description: The claim's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The claim's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The claim's metadata. + description: The claim's metadata, can hold custom key-value pairs. AdminPostReturnsRequestItemsReqSchema: type: object - description: SUMMARY + description: The items' details. x-schemaName: AdminPostReturnsRequestItemsReqSchema properties: items: type: array - description: The claim's items. + description: The items' details. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -12219,49 +12216,49 @@ components: internal_note: type: string title: internal_note - description: The item's internal note. + description: A note viewed only by admin users. reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the associated return reason. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. AdminPostReturnsReturnReqSchema: type: object - description: SUMMARY + description: The return's details. x-schemaName: AdminPostReturnsReturnReqSchema properties: location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location to return items to. no_notification: type: boolean title: no_notification - description: The return's no notification. + description: Whether the customer should receive notifications about updates to the return. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. AdminPostReturnsShippingActionReqSchema: type: object - description: SUMMARY + description: The shipping method's details. x-schemaName: AdminPostReturnsShippingActionReqSchema properties: custom_amount: type: number title: custom_amount - description: The return's custom amount. + description: Set a custom price for the shipping method. internal_note: type: string title: internal_note - description: The return's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The return's metadata. + description: The return's metadata, can hold custom key-value pairs. AdminPostReturnsShippingReqSchema: type: object - description: SUMMARY + description: The shipping method's details. x-schemaName: AdminPostReturnsShippingReqSchema required: - shipping_option_id @@ -12269,25 +12266,25 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The exchange's shipping option id. + description: The ID of the associated shipping option. custom_amount: type: number title: custom_amount - description: The exchange's custom amount. + description: Set the price of the shipping method. description: type: string title: description - description: The exchange's description. + description: The shipping method's description. internal_note: type: string title: internal_note - description: The exchange's internal note. + description: A note viewed only by admin users. metadata: type: object - description: The exchange's metadata. + description: The exchange's metadata, can hold custom key-value pairs. AdminPrice: type: object - description: The price's prices. + description: The price's details. x-schemaName: AdminPrice required: - id @@ -12314,6 +12311,7 @@ components: type: string title: currency_code description: The price's currency code. + example: usd amount: type: number title: amount @@ -12324,30 +12322,30 @@ components: min_quantity: type: number title: min_quantity - description: The price's min quantity. + description: The minimum quantity that must be available in the cart for the price to be applied. max_quantity: type: number title: max_quantity - description: The price's max quantity. + description: The maximum quantity allowed to be available in the cart for the price to be applied. price_set_id: type: string title: price_set_id - description: The price's price set id. + description: The ID of the associated price set. created_at: type: string format: date-time title: created_at - description: The price's created at. + description: The date the price was created. updated_at: type: string format: date-time title: updated_at - description: The price's updated at. + description: The date the price was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price's deleted at. + description: The date the price was deleted. AdminPriceList: type: object description: The price list's details. @@ -12384,11 +12382,11 @@ components: starts_at: type: string title: starts_at - description: The price list's starts at. + description: The date the price list starts. ends_at: type: string title: ends_at - description: The price list's ends at. + description: The date the price list ends. status: type: string description: The price list's status. @@ -12410,20 +12408,20 @@ components: type: string format: date-time title: created_at - description: The price list's created at. + description: The date the price list was created. updated_at: type: string format: date-time title: updated_at - description: The price list's updated at. + description: The date the price list was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price list's deleted at. + description: The date the price list was deleted. AdminPriceListBatchResponse: type: object - description: SUMMARY + description: The details of the created, updated, and deleted prices in a price list. x-schemaName: AdminPriceListBatchResponse required: - created @@ -12432,17 +12430,17 @@ components: properties: created: type: array - description: The price list's created. + description: The created prices. items: $ref: '#/components/schemas/AdminPrice' updated: type: array - description: The price list's updated. + description: The updated prices. items: $ref: '#/components/schemas/AdminPrice' deleted: type: object - description: SUMMARY + description: The details of the deleted prices. required: - ids - object @@ -12450,22 +12448,23 @@ components: properties: ids: type: array - description: The deleted's ids. + description: The IDs of the deleted prices. items: type: string title: ids - description: The id's ids. + description: A price's ID. object: type: string title: object - description: SUMMARY + description: The name of the deleted object. + default: price deleted: type: boolean title: deleted - description: SUMMARY + description: Whether the prices were deleted. AdminPriceListDeleteResponse: type: object - description: SUMMARY + description: The details of the deleted price list. x-schemaName: AdminPriceListDeleteResponse required: - id @@ -12484,10 +12483,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Price List was deleted. + description: Whether the price list was deleted. AdminPriceListListResponse: type: object - description: SUMMARY + description: The paginated list of price lists. x-schemaName: AdminPriceListListResponse required: - limit @@ -12498,23 +12497,23 @@ components: limit: type: number title: limit - description: The price list's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The price list's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The price list's count. + description: The total number of items. price_lists: type: array - description: The price list's price lists. + description: The list of price lists. items: $ref: '#/components/schemas/AdminPriceList' AdminPriceListPrice: type: object - description: The price's prices. + description: The details of a price list's price. x-schemaName: AdminPriceListPrice required: - variant_id @@ -12534,7 +12533,7 @@ components: variant_id: type: string title: variant_id - description: The price's variant id. + description: The ID of the product variant this price list is for. rules: type: object description: The price's rules. @@ -12550,6 +12549,7 @@ components: type: string title: currency_code description: The price's currency code. + example: usd amount: type: number title: amount @@ -12560,33 +12560,33 @@ components: min_quantity: type: number title: min_quantity - description: The price's min quantity. + description: The minimum quantity that must be available in the cart for the price to be applied. max_quantity: type: number title: max_quantity - description: The price's max quantity. + description: The maximum quantity allowed to be available in the cart for the price to be applied. price_set_id: type: string title: price_set_id - description: The price's price set id. + description: The ID of the price set this price belongs to. created_at: type: string format: date-time title: created_at - description: The price's created at. + description: The date the price was created. updated_at: type: string format: date-time title: updated_at - description: The price's updated at. + description: The date the price was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price's deleted at. + description: The date the price was deleted. AdminPriceListResponse: type: object - description: SUMMARY + description: The price list's details. x-schemaName: AdminPriceListResponse required: - price_list @@ -12614,32 +12614,34 @@ components: type: string title: attribute description: The price preference's attribute. + example: region_id value: type: string title: value description: The price preference's value. + example: reg_123 is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The price preference's is tax inclusive. + description: Whether prices matching this preference include taxes. created_at: type: string format: date-time title: created_at - description: The price preference's created at. + description: The date the price preference was created. updated_at: type: string format: date-time title: updated_at - description: The price preference's updated at. + description: The date the price preference was updated. deleted_at: type: string format: date-time title: deleted_at - description: The price preference's deleted at. + description: The date the price preference was deleted. AdminPricePreferenceDeleteResponse: type: object - description: SUMMARY + description: The details of the deleted price preference. x-schemaName: AdminPricePreferenceDeleteResponse required: - id @@ -12658,10 +12660,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Price Preference was deleted. + description: Whether the price preference was deleted. AdminPricePreferenceListResponse: type: object - description: SUMMARY + description: The paginated list of price preferences. x-schemaName: AdminPricePreferenceListResponse required: - limit @@ -12672,23 +12674,23 @@ components: limit: type: number title: limit - description: The price preference's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The price preference's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The price preference's count. + description: The total count of items. price_preferences: type: array - description: The price preference's price preferences. + description: The list of price preferences. items: $ref: '#/components/schemas/AdminPricePreference' AdminPricePreferenceResponse: type: object - description: SUMMARY + description: The price preference's details. x-schemaName: AdminPricePreferenceResponse required: - price_preference @@ -12697,7 +12699,7 @@ components: $ref: '#/components/schemas/AdminPricePreference' AdminProduct: type: object - description: The product's parent. + description: The product's details. x-schemaName: AdminProduct required: - type @@ -12731,37 +12733,37 @@ components: $ref: '#/components/schemas/AdminCollection' categories: type: array - description: The parent's categories. + description: The product's categories. items: $ref: '#/components/schemas/AdminProductCategory' sales_channels: type: array - description: The parent's sales channels. + description: The sales channels that the product is available in. items: $ref: '#/components/schemas/AdminSalesChannel' variants: type: array - description: The parent's variants. + description: The product's variants. items: $ref: '#/components/schemas/AdminProductVariant' type: $ref: '#/components/schemas/AdminProductType' tags: type: array - description: The parent's tags. + description: The product's tags. items: $ref: '#/components/schemas/AdminProductTag' length: type: number title: length - description: The parent's length. + description: The product's length. title: type: string title: title - description: The parent's title. + description: The product's title. status: type: string - description: The parent's status. + description: The product's status. enum: - draft - proposed @@ -12769,103 +12771,103 @@ components: - rejected options: type: array - description: The parent's options. + description: The product's options. items: $ref: '#/components/schemas/BaseProductOption' description: type: string title: description - description: The parent's description. + description: The product's description. id: type: string title: id - description: The parent's ID. + description: The product's ID. metadata: type: object - description: The parent's metadata. + description: The product's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the product was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the product was updated. handle: type: string title: handle - description: The parent's handle. + description: The product's unique handle. subtitle: type: string title: subtitle - description: The parent's subtitle. + description: The product's subtitle. is_giftcard: type: boolean title: is_giftcard - description: The parent's is giftcard. + description: Whether the product is a gift card. thumbnail: type: string title: thumbnail - description: The parent's thumbnail. + description: The product's thumbnail. width: type: number title: width - description: The parent's width. + description: The product's width. weight: type: number title: weight - description: The parent's weight. + description: The product's weight. height: type: number title: height - description: The parent's height. + description: The product's height. origin_country: type: string title: origin_country - description: The parent's origin country. + description: The product's origin country. hs_code: type: string title: hs_code - description: The parent's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The parent's mid code. + description: The product's MID code. material: type: string title: material - description: The parent's material. + description: The product's material. collection_id: type: string title: collection_id - description: The parent's collection id. + description: The ID of the collection that the product belongs to. type_id: type: string title: type_id - description: The parent's type id. + description: The ID of the product's type. images: type: array - description: The parent's images. + description: The product's images. items: $ref: '#/components/schemas/BaseProductImage' discountable: type: boolean title: discountable - description: The parent's discountable. + description: Whether discounts can be applied on the product. external_id: type: string title: external_id - description: The parent's external id. + description: The ID of a product in an external system, such as an ERP or CMS. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the product was deleted. AdminProductCategory: type: object - description: The category's categories. + description: The product category's details. x-schemaName: AdminProductCategory required: - category_children @@ -12884,7 +12886,7 @@ components: properties: category_children: type: array - description: The category's category children. + description: The category's children. items: type: object parent_category: @@ -12908,45 +12910,45 @@ components: description: The category's ID. metadata: type: object - description: The category's metadata. + description: The category's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The category's created at. + description: The date the category was created. updated_at: type: string format: date-time title: updated_at - description: The category's updated at. + description: The date the category was updated. handle: type: string title: handle - description: The category's handle. + description: The category's unique handle. deleted_at: type: string format: date-time title: deleted_at - description: The category's deleted at. + description: The date the category was deleted. is_active: type: boolean title: is_active - description: The category's is active. + description: Whether the category is active. If disabled, the category isn't shown in the storefront. is_internal: type: boolean title: is_internal - description: The category's is internal. + description: Whether the category is internal. If enabled, the category is only seen by admin users. rank: type: number title: rank - description: The category's rank. + description: The category's rank among sibling categories. parent_category_id: type: string title: parent_category_id - description: The category's parent category id. + description: The ID of the category's parent. AdminProductCategoryDeleteResponse: type: object - description: SUMMARY + description: The details of deleting the category. x-schemaName: AdminProductCategoryDeleteResponse required: - id @@ -12965,10 +12967,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Product Category was deleted. + description: Whether the product category was deleted. AdminProductCategoryListResponse: type: object - description: SUMMARY + description: The paginated list of product categories. x-schemaName: AdminProductCategoryListResponse required: - limit @@ -12979,23 +12981,23 @@ components: limit: type: number title: limit - description: The product category's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product category's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product category's count. + description: The total number of items. product_categories: type: array - description: The product category's product categories. + description: The list of product categories. items: $ref: '#/components/schemas/AdminProductCategory' AdminProductCategoryResponse: type: object - description: SUMMARY + description: The product category's details. x-schemaName: AdminProductCategoryResponse required: - product_category @@ -13004,7 +13006,7 @@ components: $ref: '#/components/schemas/AdminProductCategory' AdminProductDeleteResponse: type: object - description: SUMMARY + description: The details of the product deletion. x-schemaName: AdminProductDeleteResponse required: - id @@ -13023,7 +13025,7 @@ components: deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product was deleted. AdminProductOption: type: object description: The product's product option.