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

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

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-08-15 14:31:35 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 4bd0917aed
commit b23ddcdde8
1211 changed files with 92070 additions and 5062 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Api Keys
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The api key's ID.
* object:
* type: string
* title: object
* description: The api key's object.
* deleted:
* type: boolean
* title: deleted
* description: The api key's deleted.
* parent:
* type: object
* description: The api key's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Campaigns
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The campaign's ID.
* object:
* type: string
* title: object
* description: The campaign's object.
* deleted:
* type: boolean
* title: deleted
* description: The campaign's deleted.
* parent:
* type: object
* description: The campaign's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts
+7
View File
@@ -81,6 +81,12 @@
* tags:
* - Claims
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminClaimPreviewResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -93,6 +99,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: removeItemClaimActionWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts
+7
View File
@@ -83,6 +83,12 @@
* tags:
* - Claims
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminClaimReturnPreviewResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -95,6 +101,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: removeItemReturnActionWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts
+7
View File
@@ -84,6 +84,12 @@
* tags:
* - Claims
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminClaimReturnPreviewResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -96,6 +102,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: removeClaimShippingMethodWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts
+7
View File
@@ -83,6 +83,12 @@
* tags:
* - Claims
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminClaimPreviewResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -95,6 +101,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: removeAddItemClaimActionWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts
+7
View File
@@ -84,6 +84,12 @@
* tags:
* - Claims
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminClaimPreviewResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -96,6 +102,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: removeClaimShippingMethodWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Claims
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminClaimDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Collections
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCollectionDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The customer group's ID.
* object:
* type: string
* title: object
* description: The customer group's object.
* deleted:
* type: boolean
* title: deleted
* description: The customer group's deleted.
* parent:
* type: object
* description: The customer group's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The customer's ID.
* object:
* type: string
* title: object
* description: The customer's object.
* deleted:
* type: boolean
* title: deleted
* description: The customer's deleted.
* parent:
* type: object
* description: The customer's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts
+27
View File
@@ -83,6 +83,33 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The customer's ID.
* object:
* type: string
* title: object
* description: The customer's object.
* deleted:
* type: boolean
* title: deleted
* description: The customer's deleted.
* parent:
* type: object
* description: The customer's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts
+107
View File
@@ -0,0 +1,107 @@
/**
* @oas [delete] /admin/exchanges/{id}/inbound/items/{action_id}
* operationId: DeleteExchangesIdInboundItemsAction_id
* summary: Remove Items from Exchange
* description: Remove a list of items from a exchange. This doesn't delete the
* Item, only the association between the Item and the exchange.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The exchange's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The exchange'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/exchanges/{id}/inbound/items/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Exchanges
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminExchangeReturnResponse"
* "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"
* x-workflow: removeItemReturnActionWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts
+108
View File
@@ -0,0 +1,108 @@
/**
* @oas [delete] /admin/exchanges/{id}/inbound/shipping-method/{action_id}
* operationId: DeleteExchangesIdInboundShippingMethodAction_id
* summary: Remove Shipping Methods from Exchange
* description: Remove a list of shipping methods from a exchange. This doesn't
* delete the Shipping Method, only the association between the Shipping Method
* and the exchange.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The exchange's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The exchange'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/exchanges/{id}/inbound/shipping-method/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Exchanges
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminExchangeReturnResponse"
* "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"
* x-workflow: removeReturnShippingMethodWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts
+107
View File
@@ -0,0 +1,107 @@
/**
* @oas [delete] /admin/exchanges/{id}/outbound/items/{action_id}
* operationId: DeleteExchangesIdOutboundItemsAction_id
* summary: Remove Items from Exchange
* description: Remove a list of items from a exchange. This doesn't delete the
* Item, only the association between the Item and the exchange.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The exchange's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The exchange'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/exchanges/{id}/outbound/items/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Exchanges
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminExchangePreviewResponse"
* "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"
* x-workflow: removeItemExchangeActionWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts
+109
View File
@@ -0,0 +1,109 @@
/**
* @oas [delete] /admin/exchanges/{id}/outbound/shipping-method/{action_id}
* operationId: DeleteExchangesIdOutboundShippingMethodAction_id
* summary: Remove Shipping Methods from Exchange
* description: Remove a list of shipping methods from a exchange. This doesn't
* delete the Shipping Method, only the association between the Shipping Method
* and the exchange.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The exchange's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The exchange'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/exchanges/{id}/outbound/shipping-method/{action_id}'
* \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Exchanges
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminExchangePreviewResponse"
* "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"
* x-workflow: removeExchangeShippingMethodWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts
+119
View File
@@ -0,0 +1,119 @@
/**
* @oas [delete] /admin/exchanges/{id}/request
* operationId: DeleteExchangesIdRequest
* summary: Remove Requests from Exchange
* description: Remove a list of requests from a exchange. This doesn't delete the
* Request, only the association between the Request and the exchange.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The exchange'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: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/exchanges/{id}/request' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Exchanges
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The exchange's ID.
* object:
* type: string
* title: object
* description: The exchange's object.
* deleted:
* type: boolean
* title: deleted
* description: The exchange's deleted.
* parent:
* type: object
* description: The exchange's parent.
* "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"
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts
+27
View File
@@ -84,6 +84,33 @@
* tags:
* - Fulfillment Sets
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The fulfillment set's ID.
* object:
* type: string
* title: object
* description: The fulfillment set's object.
* deleted:
* type: boolean
* title: deleted
* description: The fulfillment set's deleted.
* parent:
* type: object
* description: The fulfillment set's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The inventory item's ID.
* object:
* type: string
* title: object
* description: The inventory item's object.
* deleted:
* type: boolean
* title: deleted
* description: The inventory item's deleted.
* parent:
* type: object
* description: The inventory item's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts
+27
View File
@@ -84,6 +84,33 @@
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The inventory item's ID.
* object:
* type: string
* title: object
* description: The inventory item's object.
* deleted:
* type: boolean
* title: deleted
* description: The inventory item's deleted.
* parent:
* type: object
* description: The inventory item's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts
+27
View File
@@ -68,6 +68,33 @@
* tags:
* - Invites
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The invite's ID.
* object:
* type: string
* title: object
* description: The invite's object.
* deleted:
* type: boolean
* title: deleted
* description: The invite's deleted.
* parent:
* type: object
* description: The invite's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPriceListDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Price Preferences
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPricePreferenceDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Product Categories
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductCategoryDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Product Tags
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductTagDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductTypeDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts
+7
View File
@@ -91,6 +91,12 @@
* tags:
* - Products
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductVariantInventoryLinkDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -103,6 +109,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: dismissLinksWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The promotion's ID.
* object:
* type: string
* title: object
* description: The promotion's object.
* deleted:
* type: boolean
* title: deleted
* description: The promotion's deleted.
* parent:
* type: object
* description: The promotion's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts
+118
View File
@@ -0,0 +1,118 @@
/**
* @oas [delete] /admin/refund-reasons/{id}
* operationId: DeleteRefundReasonsId
* summary: Delete a Refund Reason
* description: Delete a refund reason.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The refund reason'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: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/refund-reasons/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Refund Reasons
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The refund reason's ID.
* object:
* type: string
* title: object
* description: The refund reason's object.
* deleted:
* type: boolean
* title: deleted
* description: The refund reason's deleted.
* parent:
* type: object
* description: The refund reason's parent.
* "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"
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Regions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The region's ID.
* object:
* type: string
* title: object
* description: The region's object.
* deleted:
* type: boolean
* title: deleted
* description: The region's deleted.
* parent:
* type: object
* description: The region's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The reservation's ID.
* object:
* type: string
* title: object
* description: The reservation's object.
* deleted:
* type: boolean
* title: deleted
* description: The reservation's deleted.
* parent:
* type: object
* description: The reservation's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Return Reasons
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The return reason's ID.
* object:
* type: string
* title: object
* description: The return reason's object.
* deleted:
* type: boolean
* title: deleted
* description: The return reason's deleted.
* parent:
* type: object
* description: The return reason's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts
+7
View File
@@ -84,6 +84,12 @@
* tags:
* - Returns
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminReturnPreviewResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -96,6 +102,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: removeItemReturnActionWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts
+7
View File
@@ -84,6 +84,12 @@
* tags:
* - Returns
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminReturnPreviewResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -96,6 +102,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: removeItemReceiveReturnActionWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts
+27
View File
@@ -75,6 +75,33 @@
* tags:
* - Returns
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The return's ID.
* object:
* type: string
* title: object
* description: The return's object.
* deleted:
* type: boolean
* title: deleted
* description: The return's deleted.
* parent:
* type: object
* description: The return's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts
+7
View File
@@ -84,6 +84,12 @@
* tags:
* - Returns
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminReturnPreviewResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -96,6 +102,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: removeItemReturnActionWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts
+27
View File
@@ -75,6 +75,33 @@
* tags:
* - Returns
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The return's ID.
* object:
* type: string
* title: object
* description: The return's object.
* deleted:
* type: boolean
* title: deleted
* description: The return's deleted.
* parent:
* type: object
* description: The return's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts
+7
View File
@@ -84,6 +84,12 @@
* tags:
* - Returns
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminReturnPreviewResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -96,6 +102,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: removeReturnShippingMethodWorkflow
*
*/
www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Sales Channels
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminSalesChannelDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Stock Locations
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminStockLocationDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Tax Rates
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminTaxRateDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts
+27
View File
@@ -81,6 +81,33 @@
* tags:
* - Tax Rates
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The tax rate's ID.
* object:
* type: string
* title: object
* description: The tax rate's object.
* deleted:
* type: boolean
* title: deleted
* description: The tax rate's deleted.
* parent:
* type: object
* description: The tax rate's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Tax Regions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminTaxRegionDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Uploads
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The upload's ID.
* object:
* type: string
* title: object
* description: The upload's object.
* deleted:
* type: boolean
* title: deleted
* description: The upload's deleted.
* parent:
* type: object
* description: The upload's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts
+6
View File
@@ -68,6 +68,12 @@
* tags:
* - Users
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminUserDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts
+35
View File
@@ -69,6 +69,41 @@
* tags:
* - Api Keys
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The api key's limit.
* offset:
* type: number
* title: offset
* description: The api key's offset.
* count:
* type: number
* title: count
* description: The api key's count.
* - type: object
* description: SUMMARY
* required:
* - api_keys
* properties:
* api_keys:
* type: array
* description: The api key's api keys.
* items:
* $ref: "#/components/schemas/ApiKeyResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Api Keys
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminApiKeyResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts
+35
View File
@@ -69,6 +69,41 @@
* tags:
* - Campaigns
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The campaign's limit.
* offset:
* type: number
* title: offset
* description: The campaign's offset.
* count:
* type: number
* title: count
* description: The campaign's count.
* - type: object
* description: SUMMARY
* required:
* - campaigns
* properties:
* campaigns:
* type: array
* description: The campaign's campaigns.
* items:
* $ref: "#/components/schemas/CampaignResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Campaigns
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCampaignResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_claims.ts
+6
View File
@@ -69,6 +69,12 @@
* tags:
* - Claims
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminClaimListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts
+98
View File
@@ -0,0 +1,98 @@
/**
* @oas [get] /admin/claims/{id}
* operationId: GetClaimsId
* summary: Get a Claim
* description: Retrieve a claim by its ID. You can expand the claim's relations or
* select the fields that should be returned.
* 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: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/claims/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminClaimResponse"
* "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"
*
*/
www/utils/generated/oas-output/operations/admin/get_admin_collections.ts
+6
View File
@@ -69,6 +69,12 @@
* tags:
* - Collections
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCollectionListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Collections
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCollectionResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts
+6
View File
@@ -69,6 +69,12 @@
* tags:
* - Currencies
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCurrencyListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Currencies
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCurrencyResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts
+35
View File
@@ -70,6 +70,41 @@
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The customer group's limit.
* offset:
* type: number
* title: offset
* description: The customer group's offset.
* count:
* type: number
* title: count
* description: The customer group's count.
* - type: object
* description: SUMMARY
* required:
* - customer_groups
* properties:
* customer_groups:
* type: array
* description: The customer group's customer groups.
* items:
* $ref: "#/components/schemas/AdminCustomerGroup"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCustomerGroupResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts
+1 -7
View File
@@ -80,13 +80,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - customer
* properties:
* customer:
* $ref: "#/components/schemas/AdminCustomer"
* $ref: "#/components/schemas/AdminCustomerResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts
+35
View File
@@ -75,6 +75,41 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The customer's limit.
* offset:
* type: number
* title: offset
* description: The customer's offset.
* count:
* type: number
* title: count
* description: The customer's count.
* - type: object
* description: SUMMARY
* required:
* - addresses
* properties:
* addresses:
* type: array
* description: The customer's addresses.
* items:
* $ref: "#/components/schemas/AdminCustomerAddress"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts
+6
View File
@@ -81,6 +81,12 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCustomerAddressResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts
+32
View File
@@ -69,6 +69,38 @@
* tags:
* - Draft Orders
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The draft order's limit.
* offset:
* type: number
* title: offset
* description: The draft order's offset.
* count:
* type: number
* title: count
* description: The draft order's count.
* - type: object
* description: SUMMARY
* required:
* - draft_orders
* properties:
* draft_orders:
* $ref: "#/components/schemas/AdminOrder"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Draft Orders
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminDraftOrderResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts
+118
View File
@@ -0,0 +1,118 @@
/**
* @oas [get] /admin/exchanges
* operationId: GetExchanges
* summary: List Exchanges
* description: Retrieve a list of exchanges. The exchanges can be filtered by
* fields such as `id`. The exchanges 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/exchanges' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Exchanges
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The exchange's limit.
* offset:
* type: number
* title: offset
* description: The exchange's offset.
* count:
* type: number
* title: count
* description: The exchange's count.
* - type: object
* description: SUMMARY
* required:
* - exchanges
* properties:
* exchanges:
* $ref: "#/components/schemas/AdminExchange"
* "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"
*
*/
www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts
+6
View File
@@ -114,6 +114,12 @@
* tags:
* - Fulfillment Providers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminFulfillmentProviderListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts
+47 -2
View File
@@ -307,11 +307,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The inventory item's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The inventory item's $or.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
@@ -325,6 +335,41 @@
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The inventory item's limit.
* offset:
* type: number
* title: offset
* description: The inventory item's offset.
* count:
* type: number
* title: count
* description: The inventory item's count.
* - type: object
* description: SUMMARY
* required:
* - inventory_items
* properties:
* inventory_items:
* type: array
* description: The inventory item's inventory items.
* items:
* $ref: "#/components/schemas/AdminInventoryItem"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminInventoryItemResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts
+47 -2
View File
@@ -80,11 +80,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The inventory item's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The inventory item's $or.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
@@ -98,6 +108,41 @@
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The inventory item's limit.
* offset:
* type: number
* title: offset
* description: The inventory item's offset.
* count:
* type: number
* title: count
* description: The inventory item's count.
* - type: object
* description: SUMMARY
* required:
* - inventory_levels
* properties:
* inventory_levels:
* type: array
* description: The inventory item's inventory levels.
* items:
* $ref: "#/components/schemas/InventoryLevel"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_invites.ts
+47 -2
View File
@@ -199,11 +199,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The invite's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The invite's $or.
* items:
* type: object
* title: $or
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -211,6 +221,41 @@
* tags:
* - Invites
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The invite's limit.
* offset:
* type: number
* title: offset
* description: The invite's offset.
* count:
* type: number
* title: count
* description: The invite's count.
* - type: object
* description: SUMMARY
* required:
* - invites
* properties:
* invites:
* type: array
* description: The invite's invites.
* items:
* $ref: "#/components/schemas/AdminInvite"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts
+6
View File
@@ -69,6 +69,12 @@
* tags:
* - Invites
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminInviteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts
+18 -2
View File
@@ -95,11 +95,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The notification's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The notification's $or.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
@@ -113,6 +123,12 @@
* tags:
* - Notifications
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminNotificationListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Notifications
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminNotificationResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_orders.ts
+35
View File
@@ -69,6 +69,41 @@
* tags:
* - Orders
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The order's limit.
* offset:
* type: number
* title: offset
* description: The order's offset.
* count:
* type: number
* title: count
* description: The order's count.
* - type: object
* description: SUMMARY
* required:
* - orders
* properties:
* orders:
* type: array
* description: The order's orders.
* items:
* $ref: "#/components/schemas/AdminOrder"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Orders
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminOrderResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_preview.ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Orders
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminOrderPreviewResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_payments.ts
+47 -2
View File
@@ -197,11 +197,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The payment's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The payment's $or.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
@@ -215,6 +225,41 @@
* tags:
* - Payments
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The payment's limit.
* offset:
* type: number
* title: offset
* description: The payment's offset.
* count:
* type: number
* title: count
* description: The payment's count.
* - type: object
* description: SUMMARY
* required:
* - payments
* properties:
* payments:
* type: array
* description: The payment's payments.
* items:
* $ref: "#/components/schemas/AdminPayment"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Payments
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPaymentResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts
+47 -2
View File
@@ -81,11 +81,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The payment's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The payment's $or.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
@@ -99,6 +109,41 @@
* tags:
* - Payments
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The payment's limit.
* offset:
* type: number
* title: offset
* description: The payment's offset.
* count:
* type: number
* title: count
* description: The payment's count.
* - type: object
* description: SUMMARY
* required:
* - payment_providers
* properties:
* payment_providers:
* type: array
* description: The payment's payment providers.
* items:
* $ref: "#/components/schemas/AdminPaymentProvider"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts
+6
View File
@@ -69,6 +69,12 @@
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPriceListListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPriceListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts
+6
View File
@@ -70,6 +70,12 @@
* tags:
* - Price Preferences
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPricePreferenceListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Price Preferences
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPricePreferenceResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts
+12 -2
View File
@@ -258,11 +258,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The product category's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The product category's $or.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts
+18 -2
View File
@@ -197,11 +197,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The product tag's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The product tag's $or.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
@@ -215,6 +225,12 @@
* tags:
* - Product Tags
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductTagListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Product Tags
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductTagResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts
+18 -2
View File
@@ -197,11 +197,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The product type's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The product type's $or.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
@@ -215,6 +225,12 @@
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductTypeListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductTypeResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts
+122
View File
@@ -0,0 +1,122 @@
/**
* @oas [get] /admin/product-variants
* operationId: GetProductVariants
* summary: List Product Variants
* description: Retrieve a list of product variants. The product variants can be
* filtered by fields such as `id`. The product variants 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/product-variants' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Product Variants
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The product variant's limit.
* offset:
* type: number
* title: offset
* description: The product variant's offset.
* count:
* type: number
* title: count
* description: The product variant's count.
* - type: object
* description: SUMMARY
* required:
* - variants
* properties:
* variants:
* type: array
* description: The product variant's variants.
* items:
* $ref: "#/components/schemas/AdminProductVariant"
* "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"
*
*/
www/utils/generated/oas-output/operations/admin/get_admin_products.ts
+6
View File
@@ -12057,6 +12057,9 @@
* x-schemaName: BaseProductListParams
* - type: object
* description: The $or's details.
* type: array
* items:
* type: object
* - name: $or
* in: query
* description: The product's $or.
@@ -13971,6 +13974,9 @@
* x-schemaName: BaseProductListParams
* - type: object
* description: The $or's details.
* type: array
* items:
* type: object
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts
+6
View File
@@ -601,6 +601,9 @@
* x-schemaName: BaseProductOptionParams
* - type: object
* description: The $or's details.
* type: array
* items:
* type: object
* - name: $or
* in: query
* description: The product's $or.
@@ -1090,6 +1093,9 @@
* x-schemaName: BaseProductOptionParams
* - type: object
* description: The $or's details.
* type: array
* items:
* type: object
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts
+47 -2
View File
@@ -216,11 +216,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The promotion's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The promotion's $or.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
@@ -234,6 +244,41 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The promotion's limit.
* offset:
* type: number
* title: offset
* description: The promotion's offset.
* count:
* type: number
* title: count
* description: The promotion's count.
* - type: object
* description: SUMMARY
* required:
* - promotions
* properties:
* promotions:
* type: array
* description: The promotion's promotions.
* items:
* $ref: "#/components/schemas/AdminPromotion"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPromotionResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts
+15
View File
@@ -81,6 +81,21 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - rules
* properties:
* rules:
* type: array
* description: The promotion's rules.
* items:
* $ref: "#/components/schemas/AdminPromotionRule"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts
+15
View File
@@ -92,6 +92,21 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - attributes
* properties:
* attributes:
* type: array
* description: The promotion's attributes.
* items:
* $ref: "#/components/schemas/AdminRuleAttributeOption"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts
+15
View File
@@ -100,6 +100,21 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - values
* properties:
* values:
* type: array
* description: The promotion's values.
* items:
* $ref: "#/components/schemas/AdminRuleValueOption"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts
+122
View File
@@ -0,0 +1,122 @@
/**
* @oas [get] /admin/refund-reasons
* operationId: GetRefundReasons
* summary: List Refund Reasons
* description: Retrieve a list of refund reasons. The refund reasons can be
* filtered by fields such as `id`. The refund reasons 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/refund-reasons' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Refund Reasons
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The refund reason's limit.
* offset:
* type: number
* title: offset
* description: The refund reason's offset.
* count:
* type: number
* title: count
* description: The refund reason's count.
* - type: object
* description: SUMMARY
* required:
* - refund_reasons
* properties:
* refund_reasons:
* type: array
* description: The refund reason's refund reasons.
* items:
* $ref: "#/components/schemas/AdminRefundReason"
* "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"
*
*/
www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts
+98
View File
@@ -0,0 +1,98 @@
/**
* @oas [get] /admin/refund-reasons/{id}
* operationId: GetRefundReasonsId
* summary: Get a Refund Reason
* description: Retrieve a refund reason by its ID. You can expand the refund
* reason's relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The refund reason'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: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/refund-reasons/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Refund Reasons
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/RefundReasonResponse"
* "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"
*
*/
www/utils/generated/oas-output/operations/admin/get_admin_regions.ts
+47 -2
View File
@@ -211,11 +211,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The region's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The region's $or.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
@@ -229,6 +239,41 @@
* tags:
* - Regions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The region's limit.
* offset:
* type: number
* title: offset
* description: The region's offset.
* count:
* type: number
* title: count
* description: The region's count.
* - type: object
* description: SUMMARY
* required:
* - regions
* properties:
* regions:
* type: array
* description: The region's regions.
* items:
* $ref: "#/components/schemas/AdminRegion"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Regions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminRegionResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts
+35
View File
@@ -295,6 +295,41 @@
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The reservation's limit.
* offset:
* type: number
* title: offset
* description: The reservation's offset.
* count:
* type: number
* title: count
* description: The reservation's count.
* - type: object
* description: SUMMARY
* required:
* - reservations
* properties:
* reservations:
* type: array
* description: The reservation's reservations.
* items:
* $ref: "#/components/schemas/ReservationResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts
+6
View File
@@ -75,6 +75,12 @@
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminReservationResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

Some files were not shown because too many files have changed in this diff Show More