From e40b4c6183caeead788f958b411c8199d8fa3caa Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 29 Jul 2024 09:41:02 +0200 Subject: [PATCH] chore(docs): Generated API Reference (v2) (#8318) Co-authored-by: kodiakhq --- .../code_samples/Shell/admin_claims/get.sh | 2 + .../code_samples/Shell/admin_claims/post.sh | 8 + .../admin_claims_{id}_claim-items/post.sh | 2 + .../delete.sh | 2 + .../post.sh | 2 + .../admin_claims_{id}_inbound_items/post.sh | 2 + .../delete.sh | 2 + .../post.sh | 2 + .../post.sh | 6 + .../delete.sh | 2 + .../post.sh | 2 + .../admin_claims_{id}_outbound_items/post.sh | 2 + .../delete.sh | 2 + .../post.sh | 2 + .../post.sh | 6 + .../delete.sh | 2 + .../post.sh | 2 + .../post.sh | 2 + .../Shell/admin_returns_{id}/post.sh | 6 + .../post.sh | 2 + .../schemas/AdminExportProductResponse.yaml | 8 +- .../schemas/AdminImportProductResponse.yaml | 24 +- .../schemas/AdminPostClaimItemsReqSchema.yaml | 33 + .../AdminPostClaimsAddItemsReqSchema.yaml | 33 + .../AdminPostClaimsItemsActionReqSchema.yaml | 12 + ...dminPostClaimsShippingActionReqSchema.yaml | 15 + .../AdminPostClaimsShippingReqSchema.yaml | 25 + .../AdminPostOrderClaimsReqSchema.yaml | 28 + ...ostReturnsRequestItemsActionReqSchema.yaml | 8 +- ...AdminPostReturnsRequestItemsReqSchema.yaml | 2 +- .../AdminPostReturnsReturnReqSchema.yaml | 17 + .../AdminPostReturnsShippingReqSchema.yaml | 10 +- .../components/schemas/AdminProduct.yaml | 6 +- .../components/schemas/StoreProduct.yaml | 6 +- .../specs/admin/openapi.full.yaml | 2226 ++++++++++++++++- .../api-reference/specs/admin/openapi.yaml | 27 + .../specs/admin/paths/admin_claims.yaml | 177 ++ .../paths/admin_claims_{id}_claim-items.yaml | 96 + ...n_claims_{id}_claim-items_{action_id}.yaml | 203 ++ .../admin_claims_{id}_inbound_items.yaml | 96 + ...claims_{id}_inbound_items_{action_id}.yaml | 204 ++ ...n_claims_{id}_inbound_shipping-method.yaml | 97 + ...}_inbound_shipping-method_{action_id}.yaml | 204 ++ .../admin_claims_{id}_outbound_items.yaml | 96 + ...laims_{id}_outbound_items_{action_id}.yaml | 203 ++ ..._claims_{id}_outbound_shipping-method.yaml | 97 + ..._outbound_shipping-method_{action_id}.yaml | 204 ++ .../admin/paths/admin_inventory-items.yaml | 4 - .../specs/admin/paths/admin_invites.yaml | 9 +- .../specs/admin/paths/admin_payments.yaml | 9 +- .../admin/paths/admin_product-categories.yaml | 9 +- .../specs/admin/paths/admin_product-tags.yaml | 9 +- .../admin/paths/admin_product-types.yaml | 9 +- ...ducts_import_{transaction_id}_confirm.yaml | 92 + .../specs/admin/paths/admin_promotions.yaml | 9 +- .../specs/admin/paths/admin_regions.yaml | 9 +- .../specs/admin/paths/admin_reservations.yaml | 10 +- .../specs/admin/paths/admin_returns_{id}.yaml | 96 + .../admin/paths/admin_sales-channels.yaml | 9 +- .../admin/paths/admin_shipping-options.yaml | 9 +- .../admin/paths/admin_shipping-profiles.yaml | 9 +- .../admin/paths/admin_stock-locations.yaml | 9 +- ...-locations_{id}_fulfillment-providers.yaml | 113 + .../specs/admin/paths/admin_tax-rates.yaml | 9 +- .../specs/admin/paths/admin_tax-regions.yaml | 9 +- .../schemas/AdminExportProductResponse.yaml | 8 +- .../schemas/AdminImportProductResponse.yaml | 24 +- .../schemas/AdminPostClaimItemsReqSchema.yaml | 33 + .../AdminPostClaimsAddItemsReqSchema.yaml | 33 + .../AdminPostClaimsItemsActionReqSchema.yaml | 12 + ...dminPostClaimsShippingActionReqSchema.yaml | 15 + .../AdminPostClaimsShippingReqSchema.yaml | 25 + .../AdminPostOrderClaimsReqSchema.yaml | 28 + ...ostReturnsRequestItemsActionReqSchema.yaml | 8 +- ...AdminPostReturnsRequestItemsReqSchema.yaml | 2 +- .../AdminPostReturnsReturnReqSchema.yaml | 17 + .../AdminPostReturnsShippingReqSchema.yaml | 10 +- .../components/schemas/AdminProduct.yaml | 6 +- .../components/schemas/StoreProduct.yaml | 6 +- .../specs/store/openapi.full.yaml | 252 +- .../store/paths/store_product-categories.yaml | 9 +- .../specs/store/paths/store_products.yaml | 9 +- .../oas-output/base/admin.oas.base.yaml | 1 + ...min_claims_[id]_claim-items_[action_id].ts | 100 + ...n_claims_[id]_inbound_items_[action_id].ts | 102 + ...id]_inbound_shipping-method_[action_id].ts | 103 + ..._claims_[id]_outbound_items_[action_id].ts | 102 + ...d]_outbound_shipping-method_[action_id].ts | 103 + .../operations/admin/get_admin_claims.ts | 88 + .../admin/get_admin_inventory-items.ts | 4 - .../operations/admin/get_admin_invites.ts | 9 +- .../operations/admin/get_admin_payments.ts | 9 +- .../admin/get_admin_product-categories.ts | 9 +- .../admin/get_admin_product-tags.ts | 9 +- .../admin/get_admin_product-types.ts | 9 +- .../operations/admin/get_admin_promotions.ts | 9 +- .../operations/admin/get_admin_regions.ts | 9 +- .../admin/get_admin_reservations.ts | 10 +- .../admin/get_admin_sales-channels.ts | 9 +- .../admin/get_admin_shipping-options.ts | 9 +- .../admin/get_admin_shipping-profiles.ts | 9 +- .../admin/get_admin_stock-locations.ts | 9 +- .../operations/admin/get_admin_tax-rates.ts | 9 +- .../operations/admin/get_admin_tax-regions.ts | 9 +- .../operations/admin/post_admin_claims.ts | 98 + .../post_admin_claims_[id]_claim-items.ts | 98 + ...min_claims_[id]_claim-items_[action_id].ts | 104 + .../post_admin_claims_[id]_inbound_items.ts | 98 + ...n_claims_[id]_inbound_items_[action_id].ts | 104 + ...min_claims_[id]_inbound_shipping-method.ts | 102 + ...id]_inbound_shipping-method_[action_id].ts | 106 + .../post_admin_claims_[id]_outbound_items.ts | 98 + ..._claims_[id]_outbound_items_[action_id].ts | 106 + ...in_claims_[id]_outbound_shipping-method.ts | 102 + ...d]_outbound_shipping-method_[action_id].ts | 106 + ...roducts_import_[transaction_id]_confirm.ts | 95 + .../admin/post_admin_returns_[id].ts | 102 + ...ck-locations_[id]_fulfillment-providers.ts | 116 + .../store/get_store_product-categories.ts | 9 +- .../operations/store/get_store_products.ts | 9 +- .../schemas/AdminExportProductResponse.ts | 8 +- .../schemas/AdminImportProductResponse.ts | 24 +- .../schemas/AdminPostClaimItemsReqSchema.ts | 38 + .../AdminPostClaimsAddItemsReqSchema.ts | 38 + .../AdminPostClaimsItemsActionReqSchema.ts | 17 + .../AdminPostClaimsShippingActionReqSchema.ts | 20 + .../AdminPostClaimsShippingReqSchema.ts | 30 + .../schemas/AdminPostOrderClaimsReqSchema.ts | 33 + ...nPostReturnsRequestItemsActionReqSchema.ts | 8 +- .../AdminPostReturnsRequestItemsReqSchema.ts | 2 +- .../AdminPostReturnsReturnReqSchema.ts | 22 + .../AdminPostReturnsShippingReqSchema.ts | 10 +- .../oas-output/schemas/AdminProduct.ts | 6 +- .../oas-output/schemas/StoreProduct.ts | 6 +- 134 files changed, 7310 insertions(+), 279 deletions(-) create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/get.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_import_{transaction_id}_confirm/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-providers/post.sh create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/get_admin_claims.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts 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 new file mode 100644 index 0000000000..6683f812b3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/claims' \ +-H 'x-medusa-access-token: {api_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 new file mode 100644 index 0000000000..d8aa41e7d0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims/post.sh @@ -0,0 +1,8 @@ +curl -X POST '{backend_url}/admin/claims' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "type": "{value}", + "order_id": "{value}", + "metadata": {} +}' \ 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 new file mode 100644 index 0000000000..8d76cfe217 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items/post.sh @@ -0,0 +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 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 new file mode 100644 index 0000000000..79240df0eb --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/delete.sh @@ -0,0 +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 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 new file mode 100644 index 0000000000..a2051000ca --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/post.sh @@ -0,0 +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 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 new file mode 100644 index 0000000000..95ff587f1e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items/post.sh @@ -0,0 +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 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 new file mode 100644 index 0000000000..a4fe7b1ab3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh @@ -0,0 +1,2 @@ +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 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 new file mode 100644 index 0000000000..d3dff4cebc --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/post.sh @@ -0,0 +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 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 new file mode 100644 index 0000000000..6345f0d29d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/claims/{id}/inbound/shipping-method' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "shipping_option_id": "{value}" +}' \ 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}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh new file mode 100644 index 0000000000..37f340cadb --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh @@ -0,0 +1,2 @@ +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 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 new file mode 100644 index 0000000000..6d79981f2f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/post.sh @@ -0,0 +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 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 new file mode 100644 index 0000000000..16f0629acf --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items/post.sh @@ -0,0 +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 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 new file mode 100644 index 0000000000..2a9807a05f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh @@ -0,0 +1,2 @@ +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 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 new file mode 100644 index 0000000000..fc55d448af --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/post.sh @@ -0,0 +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 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 new file mode 100644 index 0000000000..cd206e6943 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/claims/{id}/outbound/shipping-method' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "shipping_option_id": "{value}" +}' \ 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}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh new file mode 100644 index 0000000000..5114f4da82 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh @@ -0,0 +1,2 @@ +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 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 new file mode 100644 index 0000000000..488980e9e2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/post.sh @@ -0,0 +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 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 new file mode 100644 index 0000000000..980db2cc46 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_import_{transaction_id}_confirm/post.sh @@ -0,0 +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 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 new file mode 100644 index 0000000000..7e040b54a5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/returns/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "metadata": {} +}' \ No newline at end of file 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 new file mode 100644 index 0000000000..7d1cf42f23 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-providers/post.sh @@ -0,0 +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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExportProductResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExportProductResponse.yaml index 01300d7807..ae3edcdd29 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExportProductResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExportProductResponse.yaml @@ -2,9 +2,9 @@ type: object description: SUMMARY x-schemaName: AdminExportProductResponse required: - - workflow_id + - transaction_id properties: - workflow_id: + transaction_id: type: string - title: workflow_id - description: The product's workflow id. + title: transaction_id + description: The product's transaction id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminImportProductResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminImportProductResponse.yaml index 5cc51a92b7..0074592dd1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminImportProductResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminImportProductResponse.yaml @@ -2,9 +2,25 @@ type: object description: SUMMARY x-schemaName: AdminImportProductResponse required: - - workflow_id + - transaction_id + - summary properties: - workflow_id: + transaction_id: type: string - title: workflow_id - description: The product's workflow id. + title: transaction_id + description: The product's transaction id. + summary: + type: object + description: The product's summary. + required: + - toCreate + - toUpdate + properties: + toCreate: + type: number + title: toCreate + description: The summary's tocreate. + toUpdate: + type: number + title: toUpdate + description: The summary's toupdate. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml new file mode 100644 index 0000000000..8b793a9c4a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml @@ -0,0 +1,33 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostClaimItemsReqSchema +properties: + items: + type: array + description: The claim's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. + metadata: + type: object + description: The item's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml new file mode 100644 index 0000000000..58910cdc4f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml @@ -0,0 +1,33 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostClaimsAddItemsReqSchema +properties: + items: + type: array + description: The claim's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + metadata: + type: object + description: The item's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml new file mode 100644 index 0000000000..773dcd2fc5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml @@ -0,0 +1,12 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostClaimsItemsActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The claim's quantity. + internal_note: + type: string + title: internal_note + description: The claim's internal note. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml new file mode 100644 index 0000000000..f7c3f3c219 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml @@ -0,0 +1,15 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostClaimsShippingActionReqSchema +properties: + custom_price: + type: number + title: custom_price + description: The claim's custom price. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml new file mode 100644 index 0000000000..ba1745276f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml @@ -0,0 +1,25 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostClaimsShippingReqSchema +required: + - shipping_option_id +properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The claim's shipping option id. + custom_price: + type: number + title: custom_price + description: The claim's custom price. + description: + type: string + title: description + description: The claim's description. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml new file mode 100644 index 0000000000..4eaef32fa9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -0,0 +1,28 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderClaimsReqSchema +required: + - type + - order_id + - metadata +properties: + type: + type: string + enum: + - refund + - replace + order_id: + type: string + title: order_id + description: The claim's order id. + description: + type: string + title: description + description: The claim's description. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. 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 050124ba1c..eae1e908a0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml @@ -5,15 +5,15 @@ properties: quantity: type: number title: quantity - description: The return's quantity. + description: The claim's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: The claim's internal note. reason_id: type: string title: reason_id - description: The return's reason id. + description: The claim's reason id. metadata: type: object - description: The return's metadata. + description: The claim's metadata. 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 5c017066c9..39180c5b5e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml @@ -4,7 +4,7 @@ x-schemaName: AdminPostReturnsRequestItemsReqSchema properties: items: type: array - description: The return's items. + description: The claim's items. items: type: object description: The item's items. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml new file mode 100644 index 0000000000..e752425d9b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml @@ -0,0 +1,17 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReturnsReturnReqSchema +required: + - metadata +properties: + location_id: + type: string + title: location_id + description: The return's location id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + metadata: + type: object + description: The return's metadata. 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 e854dc4565..a7a445758d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The return's shipping option id. + description: The claim's shipping option id. custom_price: type: number title: custom_price - description: The return's custom price. + description: The claim's custom price. description: type: string title: description - description: The return's description. + description: The claim's description. internal_note: type: string title: internal_note - description: The return's internal note. + description: The claim's internal note. metadata: type: object - description: The return's metadata. + description: The claim's metadata. 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 0cc4883ba2..2db6ee1407 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -81,13 +81,13 @@ properties: type: string title: id description: The parent's ID. + metadata: + type: object + description: The parent's metadata. handle: type: string title: handle description: The parent's handle. - metadata: - type: object - description: The parent's metadata. hs_code: type: string title: hs_code diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml index 7bb84cb710..79fac333e5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml @@ -64,13 +64,13 @@ properties: type: string title: id description: The product's ID. + metadata: + type: object + description: The product's metadata. handle: type: string title: handle description: The product's handle. - metadata: - type: object - description: The product's metadata. hs_code: type: string title: hs_code diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 04a3281d43..a86f6300ee 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -11,6 +11,7 @@ servers: tags: - name: Api Keys - name: Campaigns + - name: Claims - name: Collections x-associatedSchema: $ref: '#/components/schemas/AdminCollection' @@ -1235,6 +1236,1579 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/claims: + get: + operationId: GetClaims + summary: List Claims + description: Retrieve a list of claims. The claims can be filtered by fields such as `id`. The claims can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/claims' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostClaims + summary: Create Claim + description: Create a claim. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrderClaimsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "type": "{value}", + "order_id": "{value}", + "metadata": {} + }' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}/claim-items: + post: + operationId: PostClaimsIdClaimItems + summary: Add Claim Items to Claim + description: Add a list of claim items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostClaimItemsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims/{id}/claim-items' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}/claim-items/{action_id}: + post: + operationId: PostClaimsIdClaimItemsAction_id + summary: Add Claim Items to Claim + description: Add a list of claim items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostClaimsItemsActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims/{id}/claim-items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteClaimsIdClaimItemsAction_id + summary: Remove Claim Items from Claim + description: Remove a list of claim items from a claim. This doesn't delete the Claim Item, only the association between the Claim Item and the claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/claims/{id}/claim-items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}/inbound/items: + post: + operationId: PostClaimsIdInboundItems + summary: Add Items to Claim + description: Add a list of items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsRequestItemsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims/{id}/inbound/items' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}/inbound/items/{action_id}: + post: + operationId: PostClaimsIdInboundItemsAction_id + summary: Add Items to Claim + description: Add a list of items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsRequestItemsActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteClaimsIdInboundItemsAction_id + summary: Remove Items from Claim + description: Remove a list of items from a claim. This doesn't delete the Item, only the association between the Item and the claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + 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}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}/inbound/shipping-method: + post: + operationId: PostClaimsIdInboundShippingMethod + summary: Add Shipping Methods to Claim + description: Add a list of shipping methods to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsShippingReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims/{id}/inbound/shipping-method' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "shipping_option_id": "{value}" + }' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}/inbound/shipping-method/{action_id}: + post: + operationId: PostClaimsIdInboundShippingMethodAction_id + summary: Add Shipping Methods to Claim + description: Add a list of shipping methods to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostClaimsShippingActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteClaimsIdInboundShippingMethodAction_id + summary: Remove Shipping Methods from Claim + description: Remove a list of shipping methods from a claim. This doesn't delete the Shipping Method, only the association between the Shipping Method and the claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + 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}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}/outbound/items: + post: + operationId: PostClaimsIdOutboundItems + summary: Add Items to Claim + description: Add a list of items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostClaimsAddItemsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims/{id}/outbound/items' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}/outbound/items/{action_id}: + post: + operationId: PostClaimsIdOutboundItemsAction_id + summary: Add Items to Claim + description: Add a list of items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostClaimsItemsActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteClaimsIdOutboundItemsAction_id + summary: Remove Items from Claim + description: Remove a list of items from a claim. This doesn't delete the Item, only the association between the Item and the claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + 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}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}/outbound/shipping-method: + post: + operationId: PostClaimsIdOutboundShippingMethod + summary: Add Shipping Methods to Claim + description: Add a list of shipping methods to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostClaimsShippingReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims/{id}/outbound/shipping-method' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "shipping_option_id": "{value}" + }' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}/outbound/shipping-method/{action_id}: + post: + operationId: PostClaimsIdOutboundShippingMethodAction_id + summary: Add Shipping Methods to Claim + description: Add a list of shipping methods to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostClaimsShippingActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteClaimsIdOutboundShippingMethodAction_id + summary: Remove Shipping Methods from Claim + description: Remove a list of shipping methods from a claim. This doesn't delete the Shipping Method, only the association between the Shipping Method and the claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + 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}' + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/collections: get: operationId: GetCollections @@ -5049,7 +6623,6 @@ paths: description: The inventory item's weight. required: false schema: - type: object description: The inventory item's weight. required: - $eq @@ -5082,7 +6655,6 @@ paths: description: The inventory item's length. required: false schema: - type: object description: The inventory item's length. required: - $eq @@ -5115,7 +6687,6 @@ paths: description: The inventory item's height. required: false schema: - type: object description: The inventory item's height. required: - $eq @@ -5148,7 +6719,6 @@ paths: description: The inventory item's width. required: false schema: - type: object description: The inventory item's width. required: - $eq @@ -6338,7 +7908,7 @@ paths: description: The invite's created at. required: false schema: - type: object + type: string description: The invite's created at. required: - $eq @@ -6366,12 +7936,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The invite's updated at. required: false schema: - type: object + type: string description: The invite's updated at. required: - $eq @@ -6399,12 +7970,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The invite's deleted at. required: false schema: - type: object + type: string description: The invite's deleted at. required: - $eq @@ -6432,6 +8004,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -7988,7 +9561,7 @@ paths: description: The payment's created at. required: false schema: - type: object + type: string description: The payment's created at. required: - $eq @@ -8016,12 +9589,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The payment's updated at. required: false schema: - type: object + type: string description: The payment's updated at. required: - $eq @@ -8049,12 +9623,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The payment's deleted at. required: false schema: - type: object + type: string description: The payment's deleted at. required: - $eq @@ -8082,6 +9657,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -9670,7 +11246,7 @@ paths: description: The product category's created at. required: false schema: - type: object + type: string description: The product category's created at. required: - $eq @@ -9698,12 +11274,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The product category's updated at. required: false schema: - type: object + type: string description: The product category's updated at. required: - $eq @@ -9731,12 +11308,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The product category's deleted at. required: false schema: - type: object + type: string description: The product category's deleted at. required: - $eq @@ -9764,6 +11342,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -10427,7 +12006,7 @@ paths: description: The product tag's created at. required: false schema: - type: object + type: string description: The product tag's created at. required: - $eq @@ -10455,12 +12034,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The product tag's updated at. required: false schema: - type: object + type: string description: The product tag's updated at. required: - $eq @@ -10488,12 +12068,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The product tag's deleted at. required: false schema: - type: object + type: string description: The product tag's deleted at. required: - $eq @@ -10521,6 +12102,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -10987,7 +12569,7 @@ paths: description: The product type's created at. required: false schema: - type: object + type: string description: The product type's created at. required: - $eq @@ -11015,12 +12597,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The product type's updated at. required: false schema: - type: object + type: string description: The product type's updated at. required: - $eq @@ -11048,12 +12631,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The product type's deleted at. required: false schema: - type: object + type: string description: The product type's deleted at. required: - $eq @@ -11081,6 +12665,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -25817,6 +27402,92 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/products/import/{transaction_id}/confirm: + post: + operationId: PostProductsImportTransaction_idConfirm + summary: Add Confirms to Product + description: Add a list of confirms to a product. + x-authenticated: true + parameters: + - name: transaction_id + in: path + description: The product's transaction id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/products/import/{transaction_id}/confirm' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Products + responses: + '202': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/products/{id}: get: operationId: GetProductsId @@ -28687,7 +30358,7 @@ paths: description: The promotion's created at. required: false schema: - type: object + type: string description: The promotion's created at. required: - $eq @@ -28715,12 +30386,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The promotion's updated at. required: false schema: - type: object + type: string description: The promotion's updated at. required: - $eq @@ -28748,12 +30420,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The promotion's deleted at. required: false schema: - type: object + type: string description: The promotion's deleted at. required: - $eq @@ -28781,6 +30454,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -30589,7 +32263,7 @@ paths: description: The region's created at. required: false schema: - type: object + type: string description: The region's created at. required: - $eq @@ -30617,12 +32291,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The region's updated at. required: false schema: - type: object + type: string description: The region's updated at. required: - $eq @@ -30650,12 +32325,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The region's deleted at. required: false schema: - type: object + type: string description: The region's deleted at. required: - $eq @@ -30683,6 +32359,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -31259,7 +32936,6 @@ paths: description: The reservation's quantity. required: false schema: - type: object description: The reservation's quantity. required: - $eq @@ -31292,7 +32968,7 @@ paths: description: The reservation's created at. required: false schema: - type: object + type: string description: The reservation's created at. required: - $eq @@ -31320,12 +32996,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The reservation's updated at. required: false schema: - type: object + type: string description: The reservation's updated at. required: - $eq @@ -31353,12 +33030,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The reservation's deleted at. required: false schema: - type: object + type: string description: The reservation's deleted at. required: - $eq @@ -31386,6 +33064,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at security: - api_token: [] - cookie_auth: [] @@ -32424,6 +34103,100 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + post: + operationId: PostReturnsId + summary: Update a Return + description: Update a return's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsReturnReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/returns/{id}' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "metadata": {} + }' + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/returns/{id}/cancel: post: operationId: PostReturnsIdCancel @@ -34051,7 +35824,7 @@ paths: description: The sales channel's created at. required: false schema: - type: object + type: string description: The sales channel's created at. required: - $eq @@ -34079,12 +35852,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The sales channel's updated at. required: false schema: - type: object + type: string description: The sales channel's updated at. required: - $eq @@ -34112,12 +35886,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The sales channel's deleted at. required: false schema: - type: object + type: string description: The sales channel's deleted at. required: - $eq @@ -34145,6 +35920,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: location_id in: query required: false @@ -34759,7 +36535,7 @@ paths: description: The shipping option's created at. required: false schema: - type: object + type: string description: The shipping option's created at. required: - $eq @@ -34787,12 +36563,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The shipping option's updated at. required: false schema: - type: object + type: string description: The shipping option's updated at. required: - $eq @@ -34820,12 +36597,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The shipping option's deleted at. required: false schema: - type: object + type: string description: The shipping option's deleted at. required: - $eq @@ -34853,6 +36631,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at security: - api_token: [] - cookie_auth: [] @@ -35719,7 +37498,7 @@ paths: description: The shipping profile's created at. required: false schema: - type: object + type: string description: The shipping profile's created at. required: - $eq @@ -35747,12 +37526,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The shipping profile's updated at. required: false schema: - type: object + type: string description: The shipping profile's updated at. required: - $eq @@ -35780,12 +37560,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The shipping profile's deleted at. required: false schema: - type: object + type: string description: The shipping profile's deleted at. required: - $eq @@ -35813,6 +37594,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -36376,7 +38158,7 @@ paths: description: The stock location's created at. required: false schema: - type: object + type: string description: The stock location's created at. required: - $eq @@ -36404,12 +38186,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The stock location's updated at. required: false schema: - type: object + type: string description: The stock location's updated at. required: - $eq @@ -36437,12 +38220,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The stock location's deleted at. required: false schema: - type: object + type: string description: The stock location's deleted at. required: - $eq @@ -36470,6 +38254,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -36827,6 +38612,113 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/stock-locations/{id}/fulfillment-providers: + post: + operationId: PostStockLocationsIdFulfillmentProviders + summary: Add Fulfillment Providers to Stock Location + description: Add a list of fulfillment providers to a stock location. + x-authenticated: true + parameters: + - name: id + in: path + description: The stock location's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The stock location's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The stock location's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/stock-locations/{id}/fulfillment-providers' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Stock Locations + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/stock-locations/{id}/fulfillment-sets: post: operationId: PostStockLocationsIdFulfillmentSets @@ -37421,7 +39313,7 @@ paths: description: The tax rate's created at. required: false schema: - type: object + type: string description: The tax rate's created at. required: - $eq @@ -37449,12 +39341,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The tax rate's updated at. required: false schema: - type: object + type: string description: The tax rate's updated at. required: - $eq @@ -37482,12 +39375,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The tax rate's deleted at. required: false schema: - type: object + type: string description: The tax rate's deleted at. required: - $eq @@ -37515,6 +39409,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -38257,7 +40152,7 @@ paths: description: The tax region's created at. required: false schema: - type: object + type: string description: The tax region's created at. required: - $eq @@ -38285,12 +40180,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The tax region's updated at. required: false schema: - type: object + type: string description: The tax region's updated at. required: - $eq @@ -38318,12 +40214,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The tax region's deleted at. required: false schema: - type: object + type: string description: The tax region's deleted at. required: - $eq @@ -38351,6 +40248,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -41454,12 +43352,12 @@ components: description: SUMMARY x-schemaName: AdminExportProductResponse required: - - workflow_id + - transaction_id properties: - workflow_id: + transaction_id: type: string - title: workflow_id - description: The product's workflow id. + title: transaction_id + description: The product's transaction id. AdminFulfillmentProvider: type: object description: The shipping option's provider. @@ -41565,12 +43463,28 @@ components: description: SUMMARY x-schemaName: AdminImportProductResponse required: - - workflow_id + - transaction_id + - summary properties: - workflow_id: + transaction_id: type: string - title: workflow_id - description: The product's workflow id. + title: transaction_id + description: The product's transaction id. + summary: + type: object + description: The product's summary. + required: + - toCreate + - toUpdate + properties: + toCreate: + type: number + title: toCreate + description: The summary's tocreate. + toUpdate: + type: number + title: toUpdate + description: The summary's toupdate. AdminOrderCancelFulfillment: type: object description: SUMMARY @@ -41689,6 +43603,158 @@ components: type: string title: internal_note description: The return's internal note. + AdminPostClaimItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostClaimItemsReqSchema + properties: + items: + type: array + description: The claim's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. + metadata: + type: object + description: The item's metadata. + AdminPostClaimsAddItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostClaimsAddItemsReqSchema + properties: + items: + type: array + description: The claim's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + metadata: + type: object + description: The item's metadata. + AdminPostClaimsItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostClaimsItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The claim's quantity. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + AdminPostClaimsShippingActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostClaimsShippingActionReqSchema + properties: + custom_price: + type: number + title: custom_price + description: The claim's custom price. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. + AdminPostClaimsShippingReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostClaimsShippingReqSchema + required: + - shipping_option_id + properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The claim's shipping option id. + custom_price: + type: number + title: custom_price + description: The claim's custom price. + description: + type: string + title: description + description: The claim's description. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. + AdminPostOrderClaimsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderClaimsReqSchema + required: + - type + - order_id + - metadata + properties: + type: + type: string + enum: + - refund + - replace + order_id: + type: string + title: order_id + description: The claim's order id. + description: + type: string + title: description + description: The claim's description. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. AdminPostReceiveReturnsReqSchema: type: object description: SUMMARY @@ -41812,18 +43878,18 @@ components: quantity: type: number title: quantity - description: The return's quantity. + description: The claim's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: The claim's internal note. reason_id: type: string title: reason_id - description: The return's reason id. + description: The claim's reason id. metadata: type: object - description: The return's metadata. + description: The claim's metadata. AdminPostReturnsRequestItemsReqSchema: type: object description: SUMMARY @@ -41831,7 +43897,7 @@ components: properties: items: type: array - description: The return's items. + description: The claim's items. items: type: object description: The item's items. @@ -41862,6 +43928,24 @@ components: metadata: type: object description: The item's metadata. + AdminPostReturnsReturnReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReturnsReturnReqSchema + required: + - metadata + properties: + location_id: + type: string + title: location_id + description: The return's location id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + metadata: + type: object + description: The return's metadata. AdminPostReturnsShippingActionReqSchema: type: object description: SUMMARY @@ -41888,22 +43972,22 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The return's shipping option id. + description: The claim's shipping option id. custom_price: type: number title: custom_price - description: The return's custom price. + description: The claim's custom price. description: type: string title: description - description: The return's description. + description: The claim's description. internal_note: type: string title: internal_note - description: The return's internal note. + description: The claim's internal note. metadata: type: object - description: The return's metadata. + description: The claim's metadata. AdminPrice: type: object description: The price's prices. @@ -42051,13 +44135,13 @@ components: type: string title: id description: The parent's ID. + metadata: + type: object + description: The parent's metadata. handle: type: string title: handle description: The parent's handle. - metadata: - type: object - description: The parent's metadata. hs_code: type: string title: hs_code @@ -44606,13 +46690,13 @@ components: type: string title: id description: The product's ID. + metadata: + type: object + description: The product's metadata. handle: type: string title: handle description: The product's handle. - metadata: - type: object - description: The product's metadata. hs_code: type: string title: hs_code diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 05e0b67862..5837c48e01 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -11,6 +11,7 @@ servers: tags: - name: Api Keys - name: Campaigns + - name: Claims - name: Collections x-associatedSchema: $ref: ./components/schemas/AdminCollection.yaml @@ -121,6 +122,28 @@ paths: $ref: paths/admin_campaigns_{id}.yaml /admin/campaigns/{id}/promotions: $ref: paths/admin_campaigns_{id}_promotions.yaml + /admin/claims: + $ref: paths/admin_claims.yaml + /admin/claims/{id}/claim-items: + $ref: paths/admin_claims_{id}_claim-items.yaml + /admin/claims/{id}/claim-items/{action_id}: + $ref: paths/admin_claims_{id}_claim-items_{action_id}.yaml + /admin/claims/{id}/inbound/items: + $ref: paths/admin_claims_{id}_inbound_items.yaml + /admin/claims/{id}/inbound/items/{action_id}: + $ref: paths/admin_claims_{id}_inbound_items_{action_id}.yaml + /admin/claims/{id}/inbound/shipping-method: + $ref: paths/admin_claims_{id}_inbound_shipping-method.yaml + /admin/claims/{id}/inbound/shipping-method/{action_id}: + $ref: paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml + /admin/claims/{id}/outbound/items: + $ref: paths/admin_claims_{id}_outbound_items.yaml + /admin/claims/{id}/outbound/items/{action_id}: + $ref: paths/admin_claims_{id}_outbound_items_{action_id}.yaml + /admin/claims/{id}/outbound/shipping-method: + $ref: paths/admin_claims_{id}_outbound_shipping-method.yaml + /admin/claims/{id}/outbound/shipping-method/{action_id}: + $ref: paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml /admin/collections: $ref: paths/admin_collections.yaml /admin/collections/{id}: @@ -247,6 +270,8 @@ paths: $ref: paths/admin_products_export.yaml /admin/products/import: $ref: paths/admin_products_import.yaml + /admin/products/import/{transaction_id}/confirm: + $ref: paths/admin_products_import_{transaction_id}_confirm.yaml /admin/products/{id}: $ref: paths/admin_products_{id}.yaml /admin/products/{id}/options: @@ -343,6 +368,8 @@ paths: $ref: paths/admin_stock-locations.yaml /admin/stock-locations/{id}: $ref: paths/admin_stock-locations_{id}.yaml + /admin/stock-locations/{id}/fulfillment-providers: + $ref: paths/admin_stock-locations_{id}_fulfillment-providers.yaml /admin/stock-locations/{id}/fulfillment-sets: $ref: paths/admin_stock-locations_{id}_fulfillment-sets.yaml /admin/stock-locations/{id}/sales-channels: diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml new file mode 100644 index 0000000000..8c7a0b3361 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml @@ -0,0 +1,177 @@ +get: + operationId: GetClaims + summary: List Claims + description: >- + Retrieve a list of claims. The claims can be filtered by fields such as + `id`. The claims can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_claims/get.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostClaims + summary: Create Claim + description: Create a claim. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostOrderClaimsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_claims/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml new file mode 100644 index 0000000000..d62c7c9371 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostClaimsIdClaimItems + summary: Add Claim Items to Claim + description: Add a list of claim items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostClaimItemsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_claims_{id}_claim-items/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml new file mode 100644 index 0000000000..11597b17ca --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml @@ -0,0 +1,203 @@ +post: + operationId: PostClaimsIdClaimItemsAction_id + summary: Add Claim Items to Claim + description: Add a list of claim items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteClaimsIdClaimItemsAction_id + summary: Remove Claim Items from Claim + description: >- + Remove a list of claim items from a claim. This doesn't delete the Claim + Item, only the association between the Claim Item and the claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/delete.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml new file mode 100644 index 0000000000..9a78ff2560 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostClaimsIdInboundItems + summary: Add Items to Claim + description: Add a list of items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_claims_{id}_inbound_items/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml new file mode 100644 index 0000000000..b64b6fcc4d --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml @@ -0,0 +1,204 @@ +post: + operationId: PostClaimsIdInboundItemsAction_id + summary: Add Items to Claim + description: Add a list of items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteClaimsIdInboundItemsAction_id + summary: Remove Items from Claim + description: >- + Remove a list of items from a claim. This doesn't delete the Item, only the + association between the Item and the claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml new file mode 100644 index 0000000000..f5f10553db --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml @@ -0,0 +1,97 @@ +post: + operationId: PostClaimsIdInboundShippingMethod + summary: Add Shipping Methods to Claim + description: Add a list of shipping methods to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostReturnsShippingReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_inbound_shipping-method/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml new file mode 100644 index 0000000000..89741e2f09 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml @@ -0,0 +1,204 @@ +post: + operationId: PostClaimsIdInboundShippingMethodAction_id + summary: Add Shipping Methods to Claim + description: Add a list of shipping methods to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteClaimsIdInboundShippingMethodAction_id + summary: Remove Shipping Methods from Claim + description: >- + Remove a list of shipping methods from a claim. This doesn't delete the + Shipping Method, only the association between the Shipping Method and the + claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml new file mode 100644 index 0000000000..88fe5f10e3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostClaimsIdOutboundItems + summary: Add Items to Claim + description: Add a list of items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostClaimsAddItemsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_claims_{id}_outbound_items/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml new file mode 100644 index 0000000000..8b04545278 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml @@ -0,0 +1,203 @@ +post: + operationId: PostClaimsIdOutboundItemsAction_id + summary: Add Items to Claim + description: Add a list of items to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteClaimsIdOutboundItemsAction_id + summary: Remove Items from Claim + description: >- + Remove a list of items from a claim. This doesn't delete the Item, only the + association between the Item and the claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml new file mode 100644 index 0000000000..64e039c1f8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml @@ -0,0 +1,97 @@ +post: + operationId: PostClaimsIdOutboundShippingMethod + summary: Add Shipping Methods to Claim + description: Add a list of shipping methods to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostClaimsShippingReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_outbound_shipping-method/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml new file mode 100644 index 0000000000..6ac8c51c05 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml @@ -0,0 +1,204 @@ +post: + operationId: PostClaimsIdOutboundShippingMethodAction_id + summary: Add Shipping Methods to Claim + description: Add a list of shipping methods to a claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/post.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteClaimsIdOutboundShippingMethodAction_id + summary: Remove Shipping Methods from Claim + description: >- + Remove a list of shipping methods from a claim. This doesn't delete the + Shipping Method, only the association between the Shipping Method and the + claim. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The claim's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh + tags: + - Claims + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml index 59db277572..1b7c370490 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml @@ -166,7 +166,6 @@ get: description: The inventory item's weight. required: false schema: - type: object description: The inventory item's weight. required: - $eq @@ -199,7 +198,6 @@ get: description: The inventory item's length. required: false schema: - type: object description: The inventory item's length. required: - $eq @@ -232,7 +230,6 @@ get: description: The inventory item's height. required: false schema: - type: object description: The inventory item's height. required: - $eq @@ -265,7 +262,6 @@ get: description: The inventory item's width. required: false schema: - type: object description: The inventory item's width. required: - $eq diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml index 8019c84f7c..d1ef2c0459 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -104,7 +104,7 @@ get: description: The invite's created at. required: false schema: - type: object + type: string description: The invite's created at. required: - $eq @@ -132,12 +132,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The invite's updated at. required: false schema: - type: object + type: string description: The invite's updated at. required: - $eq @@ -165,12 +166,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The invite's deleted at. required: false schema: - type: object + type: string description: The invite's deleted at. required: - $eq @@ -198,6 +200,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml index 86c9eb0556..7f28629bac 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml @@ -102,7 +102,7 @@ get: description: The payment's created at. required: false schema: - type: object + type: string description: The payment's created at. required: - $eq @@ -130,12 +130,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The payment's updated at. required: false schema: - type: object + type: string description: The payment's updated at. required: - $eq @@ -163,12 +164,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The payment's deleted at. required: false schema: - type: object + type: string description: The payment's deleted at. required: - $eq @@ -196,6 +198,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index e22d1c1d98..dc1e2d2034 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml @@ -163,7 +163,7 @@ get: description: The product category's created at. required: false schema: - type: object + type: string description: The product category's created at. required: - $eq @@ -191,12 +191,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The product category's updated at. required: false schema: - type: object + type: string description: The product category's updated at. required: - $eq @@ -224,12 +225,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The product category's deleted at. required: false schema: - type: object + type: string description: The product category's deleted at. required: - $eq @@ -257,6 +259,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml index db051cf1d1..21d2052461 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml @@ -102,7 +102,7 @@ get: description: The product tag's created at. required: false schema: - type: object + type: string description: The product tag's created at. required: - $eq @@ -130,12 +130,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The product tag's updated at. required: false schema: - type: object + type: string description: The product tag's updated at. required: - $eq @@ -163,12 +164,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The product tag's deleted at. required: false schema: - type: object + type: string description: The product tag's deleted at. required: - $eq @@ -196,6 +198,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml index 9c8dca37b2..576b70f231 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml @@ -102,7 +102,7 @@ get: description: The product type's created at. required: false schema: - type: object + type: string description: The product type's created at. required: - $eq @@ -130,12 +130,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The product type's updated at. required: false schema: - type: object + type: string description: The product type's updated at. required: - $eq @@ -163,12 +164,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The product type's deleted at. required: false schema: - type: object + type: string description: The product type's deleted at. required: - $eq @@ -196,6 +198,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml new file mode 100644 index 0000000000..ea37c250f5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml @@ -0,0 +1,92 @@ +post: + operationId: PostProductsImportTransaction_idConfirm + summary: Add Confirms to Product + description: Add a list of confirms to a product. + x-authenticated: true + parameters: + - name: transaction_id + in: path + description: The product's transaction id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_products_import_{transaction_id}_confirm/post.sh + tags: + - Products + responses: + '202': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml index 065f1a3629..cbefe03c1d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -121,7 +121,7 @@ get: description: The promotion's created at. required: false schema: - type: object + type: string description: The promotion's created at. required: - $eq @@ -149,12 +149,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The promotion's updated at. required: false schema: - type: object + type: string description: The promotion's updated at. required: - $eq @@ -182,12 +183,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The promotion's deleted at. required: false schema: - type: object + type: string description: The promotion's deleted at. required: - $eq @@ -215,6 +217,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml index 723375a8db..d08bf805e4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -116,7 +116,7 @@ get: description: The region's created at. required: false schema: - type: object + type: string description: The region's created at. required: - $eq @@ -144,12 +144,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The region's updated at. required: false schema: - type: object + type: string description: The region's updated at. required: - $eq @@ -177,12 +178,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The region's deleted at. required: false schema: - type: object + type: string description: The region's deleted at. required: - $eq @@ -210,6 +212,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml index 588a459d21..e9fc8c42c1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -158,7 +158,6 @@ get: description: The reservation's quantity. required: false schema: - type: object description: The reservation's quantity. required: - $eq @@ -191,7 +190,7 @@ get: description: The reservation's created at. required: false schema: - type: object + type: string description: The reservation's created at. required: - $eq @@ -219,12 +218,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The reservation's updated at. required: false schema: - type: object + type: string description: The reservation's updated at. required: - $eq @@ -252,12 +252,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The reservation's deleted at. required: false schema: - type: object + type: string description: The reservation's deleted at. required: - $eq @@ -285,6 +286,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml index 0ec8b1c361..81eb360f21 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml @@ -91,3 +91,99 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml +post: + operationId: PostReturnsId + summary: Update a Return + description: Update a return's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostReturnsReturnReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_returns_{id}/post.sh + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml index 7439fb8289..a02e4dd327 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml @@ -118,7 +118,7 @@ get: description: The sales channel's created at. required: false schema: - type: object + type: string description: The sales channel's created at. required: - $eq @@ -146,12 +146,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The sales channel's updated at. required: false schema: - type: object + type: string description: The sales channel's updated at. required: - $eq @@ -179,12 +180,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The sales channel's deleted at. required: false schema: - type: object + type: string description: The sales channel's deleted at. required: - $eq @@ -212,6 +214,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: location_id in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml index 117ac9947a..2562d65241 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml @@ -144,7 +144,7 @@ get: description: The shipping option's created at. required: false schema: - type: object + type: string description: The shipping option's created at. required: - $eq @@ -172,12 +172,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The shipping option's updated at. required: false schema: - type: object + type: string description: The shipping option's updated at. required: - $eq @@ -205,12 +206,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The shipping option's deleted at. required: false schema: - type: object + type: string description: The shipping option's deleted at. required: - $eq @@ -238,6 +240,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml index 78c25c116a..119df11a3b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml @@ -105,7 +105,7 @@ get: description: The shipping profile's created at. required: false schema: - type: object + type: string description: The shipping profile's created at. required: - $eq @@ -133,12 +133,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The shipping profile's updated at. required: false schema: - type: object + type: string description: The shipping profile's updated at. required: - $eq @@ -166,12 +167,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The shipping profile's deleted at. required: false schema: - type: object + type: string description: The shipping profile's deleted at. required: - $eq @@ -199,6 +201,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml index 67fbacf286..be4f8bcf11 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml @@ -130,7 +130,7 @@ get: description: The stock location's created at. required: false schema: - type: object + type: string description: The stock location's created at. required: - $eq @@ -158,12 +158,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The stock location's updated at. required: false schema: - type: object + type: string description: The stock location's updated at. required: - $eq @@ -191,12 +192,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The stock location's deleted at. required: false schema: - type: object + type: string description: The stock location's deleted at. required: - $eq @@ -224,6 +226,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml new file mode 100644 index 0000000000..f7429eeefe --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml @@ -0,0 +1,113 @@ +post: + operationId: PostStockLocationsIdFulfillmentProviders + summary: Add Fulfillment Providers to Stock Location + description: Add a list of fulfillment providers to a stock location. + x-authenticated: true + parameters: + - name: id + in: path + description: The stock location's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The stock location's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The stock location's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_stock-locations_{id}_fulfillment-providers/post.sh + tags: + - Stock Locations + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml index 0dad5edc90..38e3b44de4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml @@ -124,7 +124,7 @@ get: description: The tax rate's created at. required: false schema: - type: object + type: string description: The tax rate's created at. required: - $eq @@ -152,12 +152,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The tax rate's updated at. required: false schema: - type: object + type: string description: The tax rate's updated at. required: - $eq @@ -185,12 +186,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The tax rate's deleted at. required: false schema: - type: object + type: string description: The tax rate's deleted at. required: - $eq @@ -218,6 +220,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml index 58f1e2289b..d33a4d50d5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml @@ -228,7 +228,7 @@ get: description: The tax region's created at. required: false schema: - type: object + type: string description: The tax region's created at. required: - $eq @@ -256,12 +256,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The tax region's updated at. required: false schema: - type: object + type: string description: The tax region's updated at. required: - $eq @@ -289,12 +290,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The tax region's deleted at. required: false schema: - type: object + type: string description: The tax region's deleted at. required: - $eq @@ -322,6 +324,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExportProductResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExportProductResponse.yaml index 01300d7807..ae3edcdd29 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExportProductResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExportProductResponse.yaml @@ -2,9 +2,9 @@ type: object description: SUMMARY x-schemaName: AdminExportProductResponse required: - - workflow_id + - transaction_id properties: - workflow_id: + transaction_id: type: string - title: workflow_id - description: The product's workflow id. + title: transaction_id + description: The product's transaction id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminImportProductResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminImportProductResponse.yaml index 5cc51a92b7..0074592dd1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminImportProductResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminImportProductResponse.yaml @@ -2,9 +2,25 @@ type: object description: SUMMARY x-schemaName: AdminImportProductResponse required: - - workflow_id + - transaction_id + - summary properties: - workflow_id: + transaction_id: type: string - title: workflow_id - description: The product's workflow id. + title: transaction_id + description: The product's transaction id. + summary: + type: object + description: The product's summary. + required: + - toCreate + - toUpdate + properties: + toCreate: + type: number + title: toCreate + description: The summary's tocreate. + toUpdate: + type: number + title: toUpdate + description: The summary's toupdate. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml new file mode 100644 index 0000000000..8b793a9c4a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml @@ -0,0 +1,33 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostClaimItemsReqSchema +properties: + items: + type: array + description: The claim's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. + metadata: + type: object + description: The item's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml new file mode 100644 index 0000000000..58910cdc4f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml @@ -0,0 +1,33 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostClaimsAddItemsReqSchema +properties: + items: + type: array + description: The claim's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + metadata: + type: object + description: The item's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml new file mode 100644 index 0000000000..773dcd2fc5 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml @@ -0,0 +1,12 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostClaimsItemsActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The claim's quantity. + internal_note: + type: string + title: internal_note + description: The claim's internal note. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml new file mode 100644 index 0000000000..f7c3f3c219 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml @@ -0,0 +1,15 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostClaimsShippingActionReqSchema +properties: + custom_price: + type: number + title: custom_price + description: The claim's custom price. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml new file mode 100644 index 0000000000..ba1745276f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml @@ -0,0 +1,25 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostClaimsShippingReqSchema +required: + - shipping_option_id +properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The claim's shipping option id. + custom_price: + type: number + title: custom_price + description: The claim's custom price. + description: + type: string + title: description + description: The claim's description. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml new file mode 100644 index 0000000000..4eaef32fa9 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -0,0 +1,28 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderClaimsReqSchema +required: + - type + - order_id + - metadata +properties: + type: + type: string + enum: + - refund + - replace + order_id: + type: string + title: order_id + description: The claim's order id. + description: + type: string + title: description + description: The claim's description. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. 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 050124ba1c..eae1e908a0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml @@ -5,15 +5,15 @@ properties: quantity: type: number title: quantity - description: The return's quantity. + description: The claim's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: The claim's internal note. reason_id: type: string title: reason_id - description: The return's reason id. + description: The claim's reason id. metadata: type: object - description: The return's metadata. + description: The claim's metadata. 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 5c017066c9..39180c5b5e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml @@ -4,7 +4,7 @@ x-schemaName: AdminPostReturnsRequestItemsReqSchema properties: items: type: array - description: The return's items. + description: The claim's items. items: type: object description: The item's items. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml new file mode 100644 index 0000000000..e752425d9b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml @@ -0,0 +1,17 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReturnsReturnReqSchema +required: + - metadata +properties: + location_id: + type: string + title: location_id + description: The return's location id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + metadata: + type: object + description: The return's metadata. 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 e854dc4565..a7a445758d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The return's shipping option id. + description: The claim's shipping option id. custom_price: type: number title: custom_price - description: The return's custom price. + description: The claim's custom price. description: type: string title: description - description: The return's description. + description: The claim's description. internal_note: type: string title: internal_note - description: The return's internal note. + description: The claim's internal note. metadata: type: object - description: The return's metadata. + description: The claim's metadata. 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 0cc4883ba2..2db6ee1407 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -81,13 +81,13 @@ properties: type: string title: id description: The parent's ID. + metadata: + type: object + description: The parent's metadata. handle: type: string title: handle description: The parent's handle. - metadata: - type: object - description: The parent's metadata. hs_code: type: string title: hs_code diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml index 7bb84cb710..79fac333e5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml @@ -64,13 +64,13 @@ properties: type: string title: id description: The product's ID. + metadata: + type: object + description: The product's metadata. handle: type: string title: handle description: The product's handle. - metadata: - type: object - description: The product's metadata. hs_code: type: string title: hs_code diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 5fb28f59ae..98e4d5fb13 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -2770,7 +2770,7 @@ paths: description: The product category's created at. required: false schema: - type: object + type: string description: The product category's created at. required: - $eq @@ -2798,12 +2798,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The product category's updated at. required: false schema: - type: object + type: string description: The product category's updated at. required: - $eq @@ -2831,12 +2832,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The product category's deleted at. required: false schema: - type: object + type: string description: The product category's deleted at. required: - $eq @@ -2864,6 +2866,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false @@ -3195,7 +3198,7 @@ paths: description: The product's created at. required: false schema: - type: object + type: string description: The product's created at. required: - $eq @@ -3223,12 +3226,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The product's updated at. required: false schema: - type: object + type: string description: The product's updated at. required: - $eq @@ -3256,12 +3260,13 @@ paths: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The product's deleted at. required: false schema: - type: object + type: string description: The product's deleted at. required: - $eq @@ -3289,6 +3294,7 @@ paths: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: country_code in: query description: The product's country code. @@ -5375,12 +5381,12 @@ components: description: SUMMARY x-schemaName: AdminExportProductResponse required: - - workflow_id + - transaction_id properties: - workflow_id: + transaction_id: type: string - title: workflow_id - description: The product's workflow id. + title: transaction_id + description: The product's transaction id. AdminFulfillmentProvider: type: object description: The shipping option's provider. @@ -5486,12 +5492,28 @@ components: description: SUMMARY x-schemaName: AdminImportProductResponse required: - - workflow_id + - transaction_id + - summary properties: - workflow_id: + transaction_id: type: string - title: workflow_id - description: The product's workflow id. + title: transaction_id + description: The product's transaction id. + summary: + type: object + description: The product's summary. + required: + - toCreate + - toUpdate + properties: + toCreate: + type: number + title: toCreate + description: The summary's tocreate. + toUpdate: + type: number + title: toUpdate + description: The summary's toupdate. AdminOrderCancelFulfillment: type: object description: SUMMARY @@ -5610,6 +5632,158 @@ components: type: string title: internal_note description: The return's internal note. + AdminPostClaimItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostClaimItemsReqSchema + properties: + items: + type: array + description: The claim's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. + metadata: + type: object + description: The item's metadata. + AdminPostClaimsAddItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostClaimsAddItemsReqSchema + properties: + items: + type: array + description: The claim's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + metadata: + type: object + description: The item's metadata. + AdminPostClaimsItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostClaimsItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The claim's quantity. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + AdminPostClaimsShippingActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostClaimsShippingActionReqSchema + properties: + custom_price: + type: number + title: custom_price + description: The claim's custom price. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. + AdminPostClaimsShippingReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostClaimsShippingReqSchema + required: + - shipping_option_id + properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The claim's shipping option id. + custom_price: + type: number + title: custom_price + description: The claim's custom price. + description: + type: string + title: description + description: The claim's description. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. + AdminPostOrderClaimsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderClaimsReqSchema + required: + - type + - order_id + - metadata + properties: + type: + type: string + enum: + - refund + - replace + order_id: + type: string + title: order_id + description: The claim's order id. + description: + type: string + title: description + description: The claim's description. + internal_note: + type: string + title: internal_note + description: The claim's internal note. + metadata: + type: object + description: The claim's metadata. AdminPostReceiveReturnsReqSchema: type: object description: SUMMARY @@ -5733,18 +5907,18 @@ components: quantity: type: number title: quantity - description: The return's quantity. + description: The claim's quantity. internal_note: type: string title: internal_note - description: The return's internal note. + description: The claim's internal note. reason_id: type: string title: reason_id - description: The return's reason id. + description: The claim's reason id. metadata: type: object - description: The return's metadata. + description: The claim's metadata. AdminPostReturnsRequestItemsReqSchema: type: object description: SUMMARY @@ -5752,7 +5926,7 @@ components: properties: items: type: array - description: The return's items. + description: The claim's items. items: type: object description: The item's items. @@ -5783,6 +5957,24 @@ components: metadata: type: object description: The item's metadata. + AdminPostReturnsReturnReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReturnsReturnReqSchema + required: + - metadata + properties: + location_id: + type: string + title: location_id + description: The return's location id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + metadata: + type: object + description: The return's metadata. AdminPostReturnsShippingActionReqSchema: type: object description: SUMMARY @@ -5809,22 +6001,22 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The return's shipping option id. + description: The claim's shipping option id. custom_price: type: number title: custom_price - description: The return's custom price. + description: The claim's custom price. description: type: string title: description - description: The return's description. + description: The claim's description. internal_note: type: string title: internal_note - description: The return's internal note. + description: The claim's internal note. metadata: type: object - description: The return's metadata. + description: The claim's metadata. AdminPrice: type: object description: The price's prices. @@ -5972,13 +6164,13 @@ components: type: string title: id description: The parent's ID. + metadata: + type: object + description: The parent's metadata. handle: type: string title: handle description: The parent's handle. - metadata: - type: object - description: The parent's metadata. hs_code: type: string title: hs_code @@ -8527,13 +8719,13 @@ components: type: string title: id description: The product's ID. + metadata: + type: object + description: The product's metadata. handle: type: string title: handle description: The product's handle. - metadata: - type: object - description: The product's metadata. hs_code: type: string title: hs_code diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml index dbeec7cce6..ca34c4ef63 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml @@ -147,7 +147,7 @@ get: description: The product category's created at. required: false schema: - type: object + type: string description: The product category's created at. required: - $eq @@ -175,12 +175,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The product category's updated at. required: false schema: - type: object + type: string description: The product category's updated at. required: - $eq @@ -208,12 +209,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The product category's deleted at. required: false schema: - type: object + type: string description: The product category's deleted at. required: - $eq @@ -241,6 +243,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/store/paths/store_products.yaml b/www/apps/api-reference/specs/store/paths/store_products.yaml index 61c7f2495a..2ea6ce849c 100644 --- a/www/apps/api-reference/specs/store/paths/store_products.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products.yaml @@ -218,7 +218,7 @@ get: description: The product's created at. required: false schema: - type: object + type: string description: The product's created at. required: - $eq @@ -246,12 +246,13 @@ get: $gte: {} $lt: {} $lte: {} + title: created_at - name: updated_at in: query description: The product's updated at. required: false schema: - type: object + type: string description: The product's updated at. required: - $eq @@ -279,12 +280,13 @@ get: $gte: {} $lt: {} $lte: {} + title: updated_at - name: deleted_at in: query description: The product's deleted at. required: false schema: - type: object + type: string description: The product's deleted at. required: - $eq @@ -312,6 +314,7 @@ get: $gte: {} $lt: {} $lte: {} + title: deleted_at - name: country_code in: query description: The product's country code. diff --git a/www/utils/generated/oas-output/base/admin.oas.base.yaml b/www/utils/generated/oas-output/base/admin.oas.base.yaml index c7865c43f6..0157d01589 100644 --- a/www/utils/generated/oas-output/base/admin.oas.base.yaml +++ b/www/utils/generated/oas-output/base/admin.oas.base.yaml @@ -8,6 +8,7 @@ info: tags: - name: Api Keys - name: Campaigns + - name: Claims - name: Collections x-associatedSchema: $ref: "#/components/schemas/AdminCollection" diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts new file mode 100644 index 0000000000..fed2bc9cd6 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts @@ -0,0 +1,100 @@ +/** + * @oas [delete] /admin/claims/{id}/claim-items/{action_id} + * operationId: DeleteClaimsIdClaimItemsAction_id + * summary: Remove Claim Items from Claim + * description: Remove a list of claim items from a claim. This doesn't delete the + * Claim Item, only the association between the Claim Item and the claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The claim's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/claims/{id}/claim-items/{action_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts new file mode 100644 index 0000000000..f939f88958 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts @@ -0,0 +1,102 @@ +/** + * @oas [delete] /admin/claims/{id}/inbound/items/{action_id} + * operationId: DeleteClaimsIdInboundItemsAction_id + * summary: Remove Items from Claim + * description: Remove a list of items from a claim. This doesn't delete the Item, + * only the association between the Item and the claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The claim's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * 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}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts new file mode 100644 index 0000000000..582f2c8d95 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -0,0 +1,103 @@ +/** + * @oas [delete] /admin/claims/{id}/inbound/shipping-method/{action_id} + * operationId: DeleteClaimsIdInboundShippingMethodAction_id + * summary: Remove Shipping Methods from Claim + * description: Remove a list of shipping methods from a claim. This doesn't delete + * the Shipping Method, only the association between the Shipping Method and the + * claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The claim's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * 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}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts new file mode 100644 index 0000000000..b9194d0d17 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts @@ -0,0 +1,102 @@ +/** + * @oas [delete] /admin/claims/{id}/outbound/items/{action_id} + * operationId: DeleteClaimsIdOutboundItemsAction_id + * summary: Remove Items from Claim + * description: Remove a list of items from a claim. This doesn't delete the Item, + * only the association between the Item and the claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The claim's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * 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}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts new file mode 100644 index 0000000000..42f22d09dd --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -0,0 +1,103 @@ +/** + * @oas [delete] /admin/claims/{id}/outbound/shipping-method/{action_id} + * operationId: DeleteClaimsIdOutboundShippingMethodAction_id + * summary: Remove Shipping Methods from Claim + * description: Remove a list of shipping methods from a claim. This doesn't delete + * the Shipping Method, only the association between the Shipping Method and the + * claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The claim's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * 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}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts new file mode 100644 index 0000000000..2096dcc5d8 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts @@ -0,0 +1,88 @@ +/** + * @oas [get] /admin/claims + * operationId: GetClaims + * summary: List Claims + * description: Retrieve a list of claims. The claims can be filtered by fields + * such as `id`. The claims can also be sorted or paginated. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/claims' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts index 014876853e..bd32d4b623 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts @@ -162,7 +162,6 @@ * description: The inventory item's weight. * required: false * schema: - * type: object * description: The inventory item's weight. * required: * - $eq @@ -195,7 +194,6 @@ * description: The inventory item's length. * required: false * schema: - * type: object * description: The inventory item's length. * required: * - $eq @@ -228,7 +226,6 @@ * description: The inventory item's height. * required: false * schema: - * type: object * description: The inventory item's height. * required: * - $eq @@ -261,7 +258,6 @@ * description: The inventory item's width. * required: false * schema: - * type: object * description: The inventory item's width. * required: * - $eq diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts index 444e71fe61..9709f0bcb8 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts @@ -99,7 +99,7 @@ * description: The invite's created at. * required: false * schema: - * type: object + * type: string * description: The invite's created at. * required: * - $eq @@ -127,12 +127,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The invite's updated at. * required: false * schema: - * type: object + * type: string * description: The invite's updated at. * required: * - $eq @@ -160,12 +161,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The invite's deleted at. * required: false * schema: - * type: object + * type: string * description: The invite's deleted at. * required: * - $eq @@ -193,6 +195,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts index 3e7eed74d5..131127b635 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts @@ -97,7 +97,7 @@ * description: The payment's created at. * required: false * schema: - * type: object + * type: string * description: The payment's created at. * required: * - $eq @@ -125,12 +125,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The payment's updated at. * required: false * schema: - * type: object + * type: string * description: The payment's updated at. * required: * - $eq @@ -158,12 +159,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The payment's deleted at. * required: false * schema: - * type: object + * type: string * description: The payment's deleted at. * required: * - $eq @@ -191,6 +193,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts index 9e0cd22df9..5aab636a96 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts @@ -158,7 +158,7 @@ * description: The product category's created at. * required: false * schema: - * type: object + * type: string * description: The product category's created at. * required: * - $eq @@ -186,12 +186,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The product category's updated at. * required: false * schema: - * type: object + * type: string * description: The product category's updated at. * required: * - $eq @@ -219,12 +220,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The product category's deleted at. * required: false * schema: - * type: object + * type: string * description: The product category's deleted at. * required: * - $eq @@ -252,6 +254,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts index c5afd578d6..d994d96548 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts @@ -97,7 +97,7 @@ * description: The product tag's created at. * required: false * schema: - * type: object + * type: string * description: The product tag's created at. * required: * - $eq @@ -125,12 +125,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The product tag's updated at. * required: false * schema: - * type: object + * type: string * description: The product tag's updated at. * required: * - $eq @@ -158,12 +159,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The product tag's deleted at. * required: false * schema: - * type: object + * type: string * description: The product tag's deleted at. * required: * - $eq @@ -191,6 +193,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts index 2db3a56a6b..e4472efca6 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts @@ -97,7 +97,7 @@ * description: The product type's created at. * required: false * schema: - * type: object + * type: string * description: The product type's created at. * required: * - $eq @@ -125,12 +125,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The product type's updated at. * required: false * schema: - * type: object + * type: string * description: The product type's updated at. * required: * - $eq @@ -158,12 +159,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The product type's deleted at. * required: false * schema: - * type: object + * type: string * description: The product type's deleted at. * required: * - $eq @@ -191,6 +193,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts index 9f659450bc..985a060603 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts @@ -116,7 +116,7 @@ * description: The promotion's created at. * required: false * schema: - * type: object + * type: string * description: The promotion's created at. * required: * - $eq @@ -144,12 +144,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The promotion's updated at. * required: false * schema: - * type: object + * type: string * description: The promotion's updated at. * required: * - $eq @@ -177,12 +178,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The promotion's deleted at. * required: false * schema: - * type: object + * type: string * description: The promotion's deleted at. * required: * - $eq @@ -210,6 +212,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts index 7adbb54ec6..b9232545bf 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts @@ -111,7 +111,7 @@ * description: The region's created at. * required: false * schema: - * type: object + * type: string * description: The region's created at. * required: * - $eq @@ -139,12 +139,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The region's updated at. * required: false * schema: - * type: object + * type: string * description: The region's updated at. * required: * - $eq @@ -172,12 +173,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The region's deleted at. * required: false * schema: - * type: object + * type: string * description: The region's deleted at. * required: * - $eq @@ -205,6 +207,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts index 3f3975892a..8a660ed0c3 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts @@ -153,7 +153,6 @@ * description: The reservation's quantity. * required: false * schema: - * type: object * description: The reservation's quantity. * required: * - $eq @@ -186,7 +185,7 @@ * description: The reservation's created at. * required: false * schema: - * type: object + * type: string * description: The reservation's created at. * required: * - $eq @@ -214,12 +213,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The reservation's updated at. * required: false * schema: - * type: object + * type: string * description: The reservation's updated at. * required: * - $eq @@ -247,12 +247,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The reservation's deleted at. * required: false * schema: - * type: object + * type: string * description: The reservation's deleted at. * required: * - $eq @@ -280,6 +281,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts index d485127faa..5dea5e21ac 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts @@ -114,7 +114,7 @@ * description: The sales channel's created at. * required: false * schema: - * type: object + * type: string * description: The sales channel's created at. * required: * - $eq @@ -142,12 +142,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The sales channel's updated at. * required: false * schema: - * type: object + * type: string * description: The sales channel's updated at. * required: * - $eq @@ -175,12 +176,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The sales channel's deleted at. * required: false * schema: - * type: object + * type: string * description: The sales channel's deleted at. * required: * - $eq @@ -208,6 +210,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: location_id * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts index cc7ec7585c..8273fab98e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts @@ -140,7 +140,7 @@ * description: The shipping option's created at. * required: false * schema: - * type: object + * type: string * description: The shipping option's created at. * required: * - $eq @@ -168,12 +168,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The shipping option's updated at. * required: false * schema: - * type: object + * type: string * description: The shipping option's updated at. * required: * - $eq @@ -201,12 +202,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The shipping option's deleted at. * required: false * schema: - * type: object + * type: string * description: The shipping option's deleted at. * required: * - $eq @@ -234,6 +236,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts index d3aab73b5a..b44e011af4 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts @@ -100,7 +100,7 @@ * description: The shipping profile's created at. * required: false * schema: - * type: object + * type: string * description: The shipping profile's created at. * required: * - $eq @@ -128,12 +128,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The shipping profile's updated at. * required: false * schema: - * type: object + * type: string * description: The shipping profile's updated at. * required: * - $eq @@ -161,12 +162,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The shipping profile's deleted at. * required: false * schema: - * type: object + * type: string * description: The shipping profile's deleted at. * required: * - $eq @@ -194,6 +196,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts index f089487cd9..cec32cb8ea 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts @@ -126,7 +126,7 @@ * description: The stock location's created at. * required: false * schema: - * type: object + * type: string * description: The stock location's created at. * required: * - $eq @@ -154,12 +154,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The stock location's updated at. * required: false * schema: - * type: object + * type: string * description: The stock location's updated at. * required: * - $eq @@ -187,12 +188,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The stock location's deleted at. * required: false * schema: - * type: object + * type: string * description: The stock location's deleted at. * required: * - $eq @@ -220,6 +222,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts index 2210fcd0a7..10748fd8e4 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts @@ -119,7 +119,7 @@ * description: The tax rate's created at. * required: false * schema: - * type: object + * type: string * description: The tax rate's created at. * required: * - $eq @@ -147,12 +147,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The tax rate's updated at. * required: false * schema: - * type: object + * type: string * description: The tax rate's updated at. * required: * - $eq @@ -180,12 +181,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The tax rate's deleted at. * required: false * schema: - * type: object + * type: string * description: The tax rate's deleted at. * required: * - $eq @@ -213,6 +215,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts index fa94642d3d..73aa15247e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts @@ -223,7 +223,7 @@ * description: The tax region's created at. * required: false * schema: - * type: object + * type: string * description: The tax region's created at. * required: * - $eq @@ -251,12 +251,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The tax region's updated at. * required: false * schema: - * type: object + * type: string * description: The tax region's updated at. * required: * - $eq @@ -284,12 +285,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The tax region's deleted at. * required: false * schema: - * type: object + * type: string * description: The tax region's deleted at. * required: * - $eq @@ -317,6 +319,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts new file mode 100644 index 0000000000..7634f4efb3 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts @@ -0,0 +1,98 @@ +/** + * @oas [post] /admin/claims + * operationId: PostClaims + * summary: Create Claim + * description: Create a claim. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostOrderClaimsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/claims' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "type": "{value}", + * "order_id": "{value}", + * "metadata": {} + * }' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts new file mode 100644 index 0000000000..47440854bd --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts @@ -0,0 +1,98 @@ +/** + * @oas [post] /admin/claims/{id}/claim-items + * operationId: PostClaimsIdClaimItems + * summary: Add Claim Items to Claim + * description: Add a list of claim items to a claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostClaimItemsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/claims/{id}/claim-items' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts new file mode 100644 index 0000000000..2cd2fac171 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts @@ -0,0 +1,104 @@ +/** + * @oas [post] /admin/claims/{id}/claim-items/{action_id} + * operationId: PostClaimsIdClaimItemsAction_id + * summary: Add Claim Items to Claim + * description: Add a list of claim items to a claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The claim's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostClaimsItemsActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/claims/{id}/claim-items/{action_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts new file mode 100644 index 0000000000..255b34480e --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts @@ -0,0 +1,98 @@ +/** + * @oas [post] /admin/claims/{id}/inbound/items + * operationId: PostClaimsIdInboundItems + * summary: Add Items to Claim + * description: Add a list of items to a claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsRequestItemsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/claims/{id}/inbound/items' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts new file mode 100644 index 0000000000..08bc8df36c --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts @@ -0,0 +1,104 @@ +/** + * @oas [post] /admin/claims/{id}/inbound/items/{action_id} + * operationId: PostClaimsIdInboundItemsAction_id + * summary: Add Items to Claim + * description: Add a list of items to a claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The claim's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsRequestItemsActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts new file mode 100644 index 0000000000..3f39a5697a --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts @@ -0,0 +1,102 @@ +/** + * @oas [post] /admin/claims/{id}/inbound/shipping-method + * operationId: PostClaimsIdInboundShippingMethod + * summary: Add Shipping Methods to Claim + * description: Add a list of shipping methods to a claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsShippingReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/claims/{id}/inbound/shipping-method' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "shipping_option_id": "{value}" + * }' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts new file mode 100644 index 0000000000..4bf3e1cfe4 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -0,0 +1,106 @@ +/** + * @oas [post] /admin/claims/{id}/inbound/shipping-method/{action_id} + * operationId: PostClaimsIdInboundShippingMethodAction_id + * summary: Add Shipping Methods to Claim + * description: Add a list of shipping methods to a claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The claim's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostClaimsShippingActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts new file mode 100644 index 0000000000..959c633d34 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts @@ -0,0 +1,98 @@ +/** + * @oas [post] /admin/claims/{id}/outbound/items + * operationId: PostClaimsIdOutboundItems + * summary: Add Items to Claim + * description: Add a list of items to a claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostClaimsAddItemsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/claims/{id}/outbound/items' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts new file mode 100644 index 0000000000..090a138778 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts @@ -0,0 +1,106 @@ +/** + * @oas [post] /admin/claims/{id}/outbound/items/{action_id} + * operationId: PostClaimsIdOutboundItemsAction_id + * summary: Add Items to Claim + * description: Add a list of items to a claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The claim's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostClaimsItemsActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts new file mode 100644 index 0000000000..cf644e260b --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts @@ -0,0 +1,102 @@ +/** + * @oas [post] /admin/claims/{id}/outbound/shipping-method + * operationId: PostClaimsIdOutboundShippingMethod + * summary: Add Shipping Methods to Claim + * description: Add a list of shipping methods to a claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostClaimsShippingReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/claims/{id}/outbound/shipping-method' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "shipping_option_id": "{value}" + * }' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts new file mode 100644 index 0000000000..30e423b53c --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -0,0 +1,106 @@ +/** + * @oas [post] /admin/claims/{id}/outbound/shipping-method/{action_id} + * operationId: PostClaimsIdOutboundShippingMethodAction_id + * summary: Add Shipping Methods to Claim + * description: Add a list of shipping methods to a claim. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The claim's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostClaimsShippingActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts new file mode 100644 index 0000000000..434fd96957 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts @@ -0,0 +1,95 @@ +/** + * @oas [post] /admin/products/import/{transaction_id}/confirm + * operationId: PostProductsImportTransaction_idConfirm + * summary: Add Confirms to Product + * description: Add a list of confirms to a product. + * x-authenticated: true + * parameters: + * - name: transaction_id + * in: path + * description: The product's transaction id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/products/import/{transaction_id}/confirm' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Products + * responses: + * "202": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts new file mode 100644 index 0000000000..9a76289a05 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts @@ -0,0 +1,102 @@ +/** + * @oas [post] /admin/returns/{id} + * operationId: PostReturnsId + * summary: Update a Return + * description: Update a return's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsReturnReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/returns/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "metadata": {} + * }' + * tags: + * - Returns + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts new file mode 100644 index 0000000000..de3b0cf02a --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts @@ -0,0 +1,116 @@ +/** + * @oas [post] /admin/stock-locations/{id}/fulfillment-providers + * operationId: PostStockLocationsIdFulfillmentProviders + * summary: Add Fulfillment Providers to Stock Location + * description: Add a list of fulfillment providers to a stock location. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The stock location's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: + * add: + * type: array + * description: The stock location's add. + * items: + * type: string + * title: add + * description: The add's details. + * remove: + * type: array + * description: The stock location's remove. + * items: + * type: string + * title: remove + * description: The remove's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/stock-locations/{id}/fulfillment-providers' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Stock Locations + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts index add74bbd16..49a915e31d 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts @@ -142,7 +142,7 @@ * description: The product category's created at. * required: false * schema: - * type: object + * type: string * description: The product category's created at. * required: * - $eq @@ -170,12 +170,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The product category's updated at. * required: false * schema: - * type: object + * type: string * description: The product category's updated at. * required: * - $eq @@ -203,12 +204,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The product category's deleted at. * required: false * schema: - * type: object + * type: string * description: The product category's deleted at. * required: * - $eq @@ -236,6 +238,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/store/get_store_products.ts b/www/utils/generated/oas-output/operations/store/get_store_products.ts index 44ffd9ba8c..9492086eb2 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products.ts @@ -213,7 +213,7 @@ * description: The product's created at. * required: false * schema: - * type: object + * type: string * description: The product's created at. * required: * - $eq @@ -241,12 +241,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: created_at * - name: updated_at * in: query * description: The product's updated at. * required: false * schema: - * type: object + * type: string * description: The product's updated at. * required: * - $eq @@ -274,12 +275,13 @@ * $gte: {} * $lt: {} * $lte: {} + * title: updated_at * - name: deleted_at * in: query * description: The product's deleted at. * required: false * schema: - * type: object + * type: string * description: The product's deleted at. * required: * - $eq @@ -307,6 +309,7 @@ * $gte: {} * $lt: {} * $lte: {} + * title: deleted_at * - name: country_code * in: query * description: The product's country code. diff --git a/www/utils/generated/oas-output/schemas/AdminExportProductResponse.ts b/www/utils/generated/oas-output/schemas/AdminExportProductResponse.ts index 939fc86b0e..a732576b8c 100644 --- a/www/utils/generated/oas-output/schemas/AdminExportProductResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminExportProductResponse.ts @@ -4,12 +4,12 @@ * description: SUMMARY * x-schemaName: AdminExportProductResponse * required: - * - workflow_id + * - transaction_id * properties: - * workflow_id: + * transaction_id: * type: string - * title: workflow_id - * description: The product's workflow id. + * title: transaction_id + * description: The product's transaction id. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminImportProductResponse.ts b/www/utils/generated/oas-output/schemas/AdminImportProductResponse.ts index 0307d5957f..9dbc7a7965 100644 --- a/www/utils/generated/oas-output/schemas/AdminImportProductResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminImportProductResponse.ts @@ -4,12 +4,28 @@ * description: SUMMARY * x-schemaName: AdminImportProductResponse * required: - * - workflow_id + * - transaction_id + * - summary * properties: - * workflow_id: + * transaction_id: * type: string - * title: workflow_id - * description: The product's workflow id. + * title: transaction_id + * description: The product's transaction id. + * summary: + * type: object + * description: The product's summary. + * required: + * - toCreate + * - toUpdate + * properties: + * toCreate: + * type: number + * title: toCreate + * description: The summary's tocreate. + * toUpdate: + * type: number + * title: toUpdate + * description: The summary's toupdate. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts new file mode 100644 index 0000000000..a47737f81e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts @@ -0,0 +1,38 @@ +/** + * @schema AdminPostClaimItemsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostClaimItemsReqSchema + * properties: + * items: + * type: array + * description: The claim's items. + * items: + * type: object + * description: The item's items. + * required: + * - id + * - quantity + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * description: + * type: string + * title: description + * description: The item's description. + * internal_note: + * type: string + * title: internal_note + * description: The item's internal note. + * metadata: + * type: object + * description: The item's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts new file mode 100644 index 0000000000..4cb5a8e01c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts @@ -0,0 +1,38 @@ +/** + * @schema AdminPostClaimsAddItemsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostClaimsAddItemsReqSchema + * properties: + * items: + * type: array + * description: The claim's items. + * items: + * type: object + * description: The item's items. + * required: + * - variant_id + * - quantity + * properties: + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * internal_note: + * type: string + * title: internal_note + * description: The item's internal note. + * metadata: + * type: object + * description: The item's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts new file mode 100644 index 0000000000..fb1bc0c8fc --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts @@ -0,0 +1,17 @@ +/** + * @schema AdminPostClaimsItemsActionReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostClaimsItemsActionReqSchema + * properties: + * quantity: + * type: number + * title: quantity + * description: The claim's quantity. + * internal_note: + * type: string + * title: internal_note + * description: The claim's internal note. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts new file mode 100644 index 0000000000..a13cd49f0d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminPostClaimsShippingActionReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostClaimsShippingActionReqSchema + * properties: + * custom_price: + * type: number + * title: custom_price + * description: The claim's custom price. + * internal_note: + * type: string + * title: internal_note + * description: The claim's internal note. + * metadata: + * type: object + * description: The claim's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts new file mode 100644 index 0000000000..d47e578798 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts @@ -0,0 +1,30 @@ +/** + * @schema AdminPostClaimsShippingReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostClaimsShippingReqSchema + * required: + * - shipping_option_id + * properties: + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The claim's shipping option id. + * custom_price: + * type: number + * title: custom_price + * description: The claim's custom price. + * description: + * type: string + * title: description + * description: The claim's description. + * internal_note: + * type: string + * title: internal_note + * description: The claim's internal note. + * metadata: + * type: object + * description: The claim's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts new file mode 100644 index 0000000000..2c38d2b0e0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts @@ -0,0 +1,33 @@ +/** + * @schema AdminPostOrderClaimsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostOrderClaimsReqSchema + * required: + * - type + * - order_id + * - metadata + * properties: + * type: + * type: string + * enum: + * - refund + * - replace + * order_id: + * type: string + * title: order_id + * description: The claim's order id. + * description: + * type: string + * title: description + * description: The claim's description. + * internal_note: + * type: string + * title: internal_note + * description: The claim's internal note. + * metadata: + * type: object + * description: The claim's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsActionReqSchema.ts index 951193fee6..d347a88160 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsActionReqSchema.ts @@ -7,18 +7,18 @@ * quantity: * type: number * title: quantity - * description: The return's quantity. + * description: The claim's quantity. * internal_note: * type: string * title: internal_note - * description: The return's internal note. + * description: The claim's internal note. * reason_id: * type: string * title: reason_id - * description: The return's reason id. + * description: The claim's reason id. * metadata: * type: object - * description: The return's metadata. + * description: The claim's metadata. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsReqSchema.ts index 8bb3cd3498..3f5a040f66 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsReqSchema.ts @@ -6,7 +6,7 @@ * properties: * items: * type: array - * description: The return's items. + * description: The claim's items. * items: * type: object * description: The item's items. diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts new file mode 100644 index 0000000000..83d95f33e1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts @@ -0,0 +1,22 @@ +/** + * @schema AdminPostReturnsReturnReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostReturnsReturnReqSchema + * required: + * - metadata + * properties: + * location_id: + * type: string + * title: location_id + * description: The return's location id. + * no_notification: + * type: boolean + * title: no_notification + * description: The return's no notification. + * metadata: + * type: object + * description: The return's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts index 0961bf5ef2..a6ed864213 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts @@ -9,22 +9,22 @@ * shipping_option_id: * type: string * title: shipping_option_id - * description: The return's shipping option id. + * description: The claim's shipping option id. * custom_price: * type: number * title: custom_price - * description: The return's custom price. + * description: The claim's custom price. * description: * type: string * title: description - * description: The return's description. + * description: The claim's description. * internal_note: * type: string * title: internal_note - * description: The return's internal note. + * description: The claim's internal note. * metadata: * type: object - * description: The return's metadata. + * description: The claim's metadata. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProduct.ts b/www/utils/generated/oas-output/schemas/AdminProduct.ts index d78bf0de76..0c9a536359 100644 --- a/www/utils/generated/oas-output/schemas/AdminProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminProduct.ts @@ -83,13 +83,13 @@ * type: string * title: id * description: The parent's ID. + * metadata: + * type: object + * description: The parent's metadata. * handle: * type: string * title: handle * description: The parent's handle. - * metadata: - * type: object - * description: The parent's metadata. * hs_code: * type: string * title: hs_code diff --git a/www/utils/generated/oas-output/schemas/StoreProduct.ts b/www/utils/generated/oas-output/schemas/StoreProduct.ts index 60f394b2fd..906120617a 100644 --- a/www/utils/generated/oas-output/schemas/StoreProduct.ts +++ b/www/utils/generated/oas-output/schemas/StoreProduct.ts @@ -66,13 +66,13 @@ * type: string * title: id * description: The product's ID. + * metadata: + * type: object + * description: The product's metadata. * handle: * type: string * title: handle * description: The product's handle. - * metadata: - * type: object - * description: The product's metadata. * hs_code: * type: string * title: hs_code