chore(docs): Updated API Reference (v2) (#8686)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
c999b414e7
commit
cc3e84f081
@@ -12228,18 +12228,12 @@ paths:
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
@@ -13900,6 +13894,7 @@ paths:
|
||||
description: SUMMARY
|
||||
required:
|
||||
- order_id
|
||||
- amount
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
@@ -13941,6 +13936,224 @@ paths:
|
||||
'500':
|
||||
$ref: '#/components/responses/500_error'
|
||||
x-workflow: createOrderPaymentCollectionWorkflow
|
||||
/admin/payment-collections/{id}:
|
||||
delete:
|
||||
operationId: DeletePaymentCollectionsId
|
||||
summary: Delete a Payment Collection
|
||||
description: Delete a payment collection.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The payment collection'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/payment-collections/{id}' \
|
||||
-H 'x-medusa-access-token: {api_token}'
|
||||
tags:
|
||||
- Payment Collections
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The payment collection's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The payment collection's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The payment collection's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The payment collection'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'
|
||||
/admin/payment-collections/{id}/mark-as-paid:
|
||||
post:
|
||||
operationId: PostPaymentCollectionsIdMarkAsPaid
|
||||
summary: Add Mark As Paids to Payment Collection
|
||||
description: Add a list of mark as paids to a payment collection.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The payment collection'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
|
||||
required:
|
||||
- order_id
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
title: order_id
|
||||
description: The payment collection's order id.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source: |-
|
||||
curl -X POST '{backend_url}/admin/payment-collections/{id}/mark-as-paid' \
|
||||
-H 'x-medusa-access-token: {api_token}' \
|
||||
-H 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"order_id": "{value}"
|
||||
}'
|
||||
tags:
|
||||
- Payment Collections
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AdminPaymentCollectionResponse'
|
||||
'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/payments:
|
||||
get:
|
||||
operationId: GetPayments
|
||||
@@ -46806,6 +47019,11 @@ components:
|
||||
description: The order's payment collections.
|
||||
items:
|
||||
$ref: '#/components/schemas/AdminPaymentCollection'
|
||||
fulfillments:
|
||||
type: array
|
||||
description: The order's fulfillments.
|
||||
items:
|
||||
$ref: '#/components/schemas/BaseOrderFulfillment'
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
@@ -46866,11 +47084,6 @@ components:
|
||||
- partially_refunded
|
||||
- refunded
|
||||
- requires_action
|
||||
fulfillments:
|
||||
type: array
|
||||
description: The order's fulfillments.
|
||||
items:
|
||||
$ref: '#/components/schemas/BaseOrderFulfillment'
|
||||
fulfillment_status:
|
||||
type: string
|
||||
enum:
|
||||
|
||||
Reference in New Issue
Block a user