chore(docs): Generated API Reference (v2) (#8175)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
co-authored by
kodiakhq
Shahed Nasser
parent
1a774d1a43
commit
7b49caf18a
+2
@@ -0,0 +1,2 @@
|
|||||||
|
curl -X DELETE '{backend_url}/admin/returns/{id}/request' \
|
||||||
|
-H 'x-medusa-access-token: {api_token}'
|
||||||
+7
@@ -10,3 +10,10 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The return's internal note.
|
description: The return's internal note.
|
||||||
|
reason_id:
|
||||||
|
type: string
|
||||||
|
title: reason_id
|
||||||
|
description: The return's reason id.
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: The return's metadata.
|
||||||
|
|||||||
+4
@@ -28,6 +28,10 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The item's internal note.
|
description: The item's internal note.
|
||||||
|
reason_id:
|
||||||
|
type: string
|
||||||
|
title: reason_id
|
||||||
|
description: The item's reason id.
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The item's metadata.
|
description: The item's metadata.
|
||||||
|
|||||||
@@ -7557,18 +7557,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -7621,8 +7615,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Orders
|
- Orders
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -7658,18 +7650,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -7707,8 +7693,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Orders
|
- Orders
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -8975,18 +8959,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -9024,8 +9002,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Price Preferences
|
- Price Preferences
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -9054,18 +9030,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -9108,8 +9078,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Price Preferences
|
- Price Preferences
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -9145,18 +9113,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -9194,8 +9156,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Price Preferences
|
- Price Preferences
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -9230,18 +9190,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -9284,8 +9238,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Price Preferences
|
- Price Preferences
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -9320,18 +9272,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -9369,8 +9315,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Price Preferences
|
- Price Preferences
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -32320,18 +32264,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -32373,6 +32311,89 @@ paths:
|
|||||||
-H 'x-medusa-access-token: {api_token}'
|
-H 'x-medusa-access-token: {api_token}'
|
||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
|
responses:
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/400_error'
|
||||||
|
'401':
|
||||||
|
$ref: '#/components/responses/unauthorized'
|
||||||
|
'404':
|
||||||
|
$ref: '#/components/responses/not_found_error'
|
||||||
|
'409':
|
||||||
|
$ref: '#/components/responses/invalid_state_error'
|
||||||
|
'422':
|
||||||
|
$ref: '#/components/responses/invalid_request_error'
|
||||||
|
'500':
|
||||||
|
$ref: '#/components/responses/500_error'
|
||||||
|
delete:
|
||||||
|
operationId: DeleteReturnsIdRequest
|
||||||
|
summary: Remove Requests from Return
|
||||||
|
description: Remove a list of requests from a return. This doesn't delete the Request, only the association between the Request and the return.
|
||||||
|
x-authenticated: true
|
||||||
|
parameters:
|
||||||
|
- name: id
|
||||||
|
in: path
|
||||||
|
description: The return's ID.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: expand
|
||||||
|
in: query
|
||||||
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: expand
|
||||||
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
|
- name: fields
|
||||||
|
in: query
|
||||||
|
description: |-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||||
|
* without prefix it will replace the entire default fields.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: fields
|
||||||
|
description: |-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||||
|
* without prefix it will replace the entire default fields.
|
||||||
|
- name: offset
|
||||||
|
in: query
|
||||||
|
description: The number of items to skip when retrieving a list.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: number
|
||||||
|
title: offset
|
||||||
|
description: The number of items to skip when retrieving a list.
|
||||||
|
- name: limit
|
||||||
|
in: query
|
||||||
|
description: Limit the number of items returned in the list.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: number
|
||||||
|
title: limit
|
||||||
|
description: Limit the number of items returned in the list.
|
||||||
|
- name: order
|
||||||
|
in: query
|
||||||
|
description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: order
|
||||||
|
description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
|
||||||
|
security:
|
||||||
|
- api_token: []
|
||||||
|
- cookie_auth: []
|
||||||
|
- jwt_token: []
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: Shell
|
||||||
|
label: cURL
|
||||||
|
source: |-
|
||||||
|
curl -X DELETE '{backend_url}/admin/returns/{id}/request' \
|
||||||
|
-H 'x-medusa-access-token: {api_token}'
|
||||||
|
tags:
|
||||||
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: OK
|
description: OK
|
||||||
@@ -32411,18 +32432,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -32465,8 +32480,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -32508,18 +32521,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -32562,8 +32569,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -32604,18 +32609,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -32653,8 +32652,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -32690,18 +32687,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -32748,8 +32739,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -32791,18 +32780,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -32845,8 +32828,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -32887,18 +32868,12 @@ paths:
|
|||||||
description: Comma-separated relations that should be expanded in the returned data.
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
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.
|
||||||
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
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
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.
|
||||||
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
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -32936,8 +32911,6 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -40744,6 +40717,13 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The return's internal note.
|
description: The return's internal note.
|
||||||
|
reason_id:
|
||||||
|
type: string
|
||||||
|
title: reason_id
|
||||||
|
description: The return's reason id.
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: The return's metadata.
|
||||||
AdminPostReturnsRequestItemsReqSchema:
|
AdminPostReturnsRequestItemsReqSchema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
@@ -40775,6 +40755,10 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The item's internal note.
|
description: The item's internal note.
|
||||||
|
reason_id:
|
||||||
|
type: string
|
||||||
|
title: reason_id
|
||||||
|
description: The item's reason id.
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The item's metadata.
|
description: The item's metadata.
|
||||||
|
|||||||
+9
-9
@@ -28,18 +28,20 @@ post:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -87,8 +89,6 @@ post:
|
|||||||
tags:
|
tags:
|
||||||
- Orders
|
- Orders
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
@@ -24,18 +24,20 @@ get:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -77,8 +79,6 @@ get:
|
|||||||
tags:
|
tags:
|
||||||
- Orders
|
- Orders
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
@@ -19,18 +19,20 @@ get:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -72,8 +74,6 @@ get:
|
|||||||
tags:
|
tags:
|
||||||
- Price Preferences
|
- Price Preferences
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
@@ -104,18 +104,20 @@ post:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -162,8 +164,6 @@ post:
|
|||||||
tags:
|
tags:
|
||||||
- Price Preferences
|
- Price Preferences
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
@@ -24,18 +24,20 @@ get:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -77,8 +79,6 @@ get:
|
|||||||
tags:
|
tags:
|
||||||
- Price Preferences
|
- Price Preferences
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
@@ -115,18 +115,20 @@ post:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -173,8 +175,6 @@ post:
|
|||||||
tags:
|
tags:
|
||||||
- Price Preferences
|
- Price Preferences
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
@@ -211,18 +211,20 @@ delete:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -264,8 +266,6 @@ delete:
|
|||||||
tags:
|
tags:
|
||||||
- Price Preferences
|
- Price Preferences
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
@@ -22,18 +22,20 @@ post:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -80,8 +82,6 @@ post:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
+18
-18
@@ -28,18 +28,20 @@ post:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -88,8 +90,6 @@ post:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
@@ -134,18 +134,20 @@ delete:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -188,8 +190,6 @@ delete:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
@@ -3,6 +3,104 @@ post:
|
|||||||
summary: Add Requests to Return
|
summary: Add Requests to Return
|
||||||
description: Add a list of requests to a return.
|
description: Add a list of requests to a return.
|
||||||
x-authenticated: true
|
x-authenticated: true
|
||||||
|
parameters:
|
||||||
|
- name: id
|
||||||
|
in: path
|
||||||
|
description: The return's ID.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: expand
|
||||||
|
in: query
|
||||||
|
description: Comma-separated relations that should be expanded in the returned data.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: expand
|
||||||
|
description: >-
|
||||||
|
Comma-separated relations that should be expanded in the returned
|
||||||
|
data.
|
||||||
|
- name: fields
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
Comma-separated fields that should be included in the returned data. if
|
||||||
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: fields
|
||||||
|
description: >-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
if a field is prefixed with `+` it will be added to the default
|
||||||
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
|
- name: offset
|
||||||
|
in: query
|
||||||
|
description: The number of items to skip when retrieving a list.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: number
|
||||||
|
title: offset
|
||||||
|
description: The number of items to skip when retrieving a list.
|
||||||
|
- name: limit
|
||||||
|
in: query
|
||||||
|
description: Limit the number of items returned in the list.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: number
|
||||||
|
title: limit
|
||||||
|
description: Limit the number of items returned in the list.
|
||||||
|
- name: order
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
The field to sort the data by. By default, the sort order is ascending.
|
||||||
|
To change the order to descending, prefix the field name with `-`.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: order
|
||||||
|
description: >-
|
||||||
|
The field to sort the data by. By default, the sort order is
|
||||||
|
ascending. To change the order to descending, prefix the field name
|
||||||
|
with `-`.
|
||||||
|
security:
|
||||||
|
- api_token: []
|
||||||
|
- cookie_auth: []
|
||||||
|
- jwt_token: []
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: Shell
|
||||||
|
label: cURL
|
||||||
|
source:
|
||||||
|
$ref: ../code_samples/Shell/admin_returns_{id}_request/post.sh
|
||||||
|
tags:
|
||||||
|
- Returns
|
||||||
|
responses:
|
||||||
|
'400':
|
||||||
|
$ref: ../components/responses/400_error.yaml
|
||||||
|
'401':
|
||||||
|
$ref: ../components/responses/unauthorized.yaml
|
||||||
|
'404':
|
||||||
|
$ref: ../components/responses/not_found_error.yaml
|
||||||
|
'409':
|
||||||
|
$ref: ../components/responses/invalid_state_error.yaml
|
||||||
|
'422':
|
||||||
|
$ref: ../components/responses/invalid_request_error.yaml
|
||||||
|
'500':
|
||||||
|
$ref: ../components/responses/500_error.yaml
|
||||||
|
delete:
|
||||||
|
operationId: DeleteReturnsIdRequest
|
||||||
|
summary: Remove Requests from Return
|
||||||
|
description: >-
|
||||||
|
Remove a list of requests from a return. This doesn't delete the Request,
|
||||||
|
only the association between the Request and the return.
|
||||||
|
x-authenticated: true
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
in: path
|
in: path
|
||||||
@@ -67,16 +165,11 @@ post:
|
|||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
- jwt_token: []
|
- jwt_token: []
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: ../components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml
|
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
source:
|
source:
|
||||||
$ref: ../code_samples/Shell/admin_returns_{id}_request/post.sh
|
$ref: ../code_samples/Shell/admin_returns_{id}_request/delete.sh
|
||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
|
|||||||
@@ -22,18 +22,20 @@ post:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -80,8 +82,6 @@ post:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
+18
-18
@@ -28,18 +28,20 @@ post:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -87,8 +89,6 @@ post:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
@@ -134,18 +134,20 @@ delete:
|
|||||||
data.
|
data.
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
Comma-separated fields that should be included in the returned data. if
|
||||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
* without prefix it will replace the entire default fields.
|
using `-` will remove it from the default fields. without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
title: fields
|
title: fields
|
||||||
description: |-
|
description: >-
|
||||||
Comma-separated fields that should be included in the returned data.
|
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.
|
if a field is prefixed with `+` it will be added to the default
|
||||||
* without prefix it will replace the entire default fields.
|
fields, using `-` will remove it from the default fields. without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
- name: offset
|
- name: offset
|
||||||
in: query
|
in: query
|
||||||
description: The number of items to skip when retrieving a list.
|
description: The number of items to skip when retrieving a list.
|
||||||
@@ -188,8 +190,6 @@ delete:
|
|||||||
tags:
|
tags:
|
||||||
- Returns
|
- Returns
|
||||||
responses:
|
responses:
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
+7
@@ -10,3 +10,10 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The return's internal note.
|
description: The return's internal note.
|
||||||
|
reason_id:
|
||||||
|
type: string
|
||||||
|
title: reason_id
|
||||||
|
description: The return's reason id.
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: The return's metadata.
|
||||||
|
|||||||
+4
@@ -28,6 +28,10 @@ properties:
|
|||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The item's internal note.
|
description: The item's internal note.
|
||||||
|
reason_id:
|
||||||
|
type: string
|
||||||
|
title: reason_id
|
||||||
|
description: The item's reason id.
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The item's metadata.
|
description: The item's metadata.
|
||||||
|
|||||||
@@ -5662,6 +5662,13 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The return's internal note.
|
description: The return's internal note.
|
||||||
|
reason_id:
|
||||||
|
type: string
|
||||||
|
title: reason_id
|
||||||
|
description: The return's reason id.
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: The return's metadata.
|
||||||
AdminPostReturnsRequestItemsReqSchema:
|
AdminPostReturnsRequestItemsReqSchema:
|
||||||
type: object
|
type: object
|
||||||
description: SUMMARY
|
description: SUMMARY
|
||||||
@@ -5693,6 +5700,10 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
title: internal_note
|
title: internal_note
|
||||||
description: The item's internal note.
|
description: The item's internal note.
|
||||||
|
reason_id:
|
||||||
|
type: string
|
||||||
|
title: reason_id
|
||||||
|
description: The item's reason id.
|
||||||
metadata:
|
metadata:
|
||||||
type: object
|
type: object
|
||||||
description: The item's metadata.
|
description: The item's metadata.
|
||||||
|
|||||||
+8
-10
@@ -21,18 +21,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -74,8 +74,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Price Preferences
|
* - Price Preferences
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
+8
-10
@@ -29,18 +29,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -84,8 +84,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Returns
|
* - Returns
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
@@ -0,0 +1,94 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/returns/{id}/request
|
||||||
|
* operationId: DeleteReturnsIdRequest
|
||||||
|
* summary: Remove Requests from Return
|
||||||
|
* description: Remove a list of requests from a return. This doesn't delete the
|
||||||
|
* Request, only the association between the Request and the return.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The return's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: expand
|
||||||
|
* in: query
|
||||||
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: expand
|
||||||
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
|
* - name: fields
|
||||||
|
* in: query
|
||||||
|
* description: >-
|
||||||
|
* Comma-separated fields that should be included in the returned data.
|
||||||
|
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||||
|
* * without prefix it will replace the entire default fields.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: fields
|
||||||
|
* description: >-
|
||||||
|
* Comma-separated fields that should be included in the returned data.
|
||||||
|
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||||
|
* * without prefix it will replace the entire default fields.
|
||||||
|
* - name: offset
|
||||||
|
* in: query
|
||||||
|
* description: The number of items to skip when retrieving a list.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: number
|
||||||
|
* title: offset
|
||||||
|
* description: The number of items to skip when retrieving a list.
|
||||||
|
* - name: limit
|
||||||
|
* in: query
|
||||||
|
* description: Limit the number of items returned in the list.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: number
|
||||||
|
* title: limit
|
||||||
|
* description: Limit the number of items returned in the list.
|
||||||
|
* - name: order
|
||||||
|
* in: query
|
||||||
|
* description: The field to sort the data by. By default, the sort order is
|
||||||
|
* ascending. To change the order to descending, prefix the field name with
|
||||||
|
* `-`.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: order
|
||||||
|
* description: The field to sort the data by. By default, the sort order is
|
||||||
|
* ascending. To change the order to descending, prefix the field name with
|
||||||
|
* `-`.
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/returns/{id}/request' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Returns
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+8
-10
@@ -29,18 +29,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -84,8 +84,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Returns
|
* - Returns
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
@@ -22,18 +22,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -75,8 +75,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Orders
|
* - Orders
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
@@ -17,18 +17,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -70,8 +70,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Price Preferences
|
* - Price Preferences
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
+8
-10
@@ -22,18 +22,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -75,8 +75,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Price Preferences
|
* - Price Preferences
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
+8
-10
@@ -27,18 +27,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -100,8 +100,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Orders
|
* - Orders
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
@@ -15,18 +15,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -73,8 +73,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Price Preferences
|
* - Price Preferences
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
+8
-10
@@ -21,18 +21,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -79,8 +79,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Price Preferences
|
* - Price Preferences
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
+8
-10
@@ -21,18 +21,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -79,8 +79,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Returns
|
* - Returns
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
+8
-10
@@ -27,18 +27,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -87,8 +87,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Returns
|
* - Returns
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
@@ -21,18 +21,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -79,8 +79,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Returns
|
* - Returns
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
+8
-10
@@ -21,18 +21,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -83,8 +83,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Returns
|
* - Returns
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
+8
-10
@@ -27,18 +27,18 @@
|
|||||||
* description: Comma-separated relations that should be expanded in the returned data.
|
* description: Comma-separated relations that should be expanded in the returned data.
|
||||||
* - name: fields
|
* - name: fields
|
||||||
* in: query
|
* in: query
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* required: false
|
* required: false
|
||||||
* schema:
|
* schema:
|
||||||
* type: string
|
* type: string
|
||||||
* title: fields
|
* title: fields
|
||||||
* description: >-
|
* description: Comma-separated fields that should be included in the returned
|
||||||
* Comma-separated fields that should be included in the returned data.
|
* data. if a field is prefixed with `+` it will be added to the default
|
||||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
* fields, using `-` will remove it from the default fields. without prefix
|
||||||
* * without prefix it will replace the entire default fields.
|
* it will replace the entire default fields.
|
||||||
* - name: offset
|
* - name: offset
|
||||||
* in: query
|
* in: query
|
||||||
* description: The number of items to skip when retrieving a list.
|
* description: The number of items to skip when retrieving a list.
|
||||||
@@ -87,8 +87,6 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Returns
|
* - Returns
|
||||||
* responses:
|
* responses:
|
||||||
* "200":
|
|
||||||
* description: OK
|
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
@@ -12,6 +12,13 @@
|
|||||||
* type: string
|
* type: string
|
||||||
* title: internal_note
|
* title: internal_note
|
||||||
* description: The return's internal note.
|
* description: The return's internal note.
|
||||||
|
* reason_id:
|
||||||
|
* type: string
|
||||||
|
* title: reason_id
|
||||||
|
* description: The return's reason id.
|
||||||
|
* metadata:
|
||||||
|
* type: object
|
||||||
|
* description: The return's metadata.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|||||||
@@ -30,6 +30,10 @@
|
|||||||
* type: string
|
* type: string
|
||||||
* title: internal_note
|
* title: internal_note
|
||||||
* description: The item's internal note.
|
* description: The item's internal note.
|
||||||
|
* reason_id:
|
||||||
|
* type: string
|
||||||
|
* title: reason_id
|
||||||
|
* description: The item's reason id.
|
||||||
* metadata:
|
* metadata:
|
||||||
* type: object
|
* type: object
|
||||||
* description: The item's metadata.
|
* description: The item's metadata.
|
||||||
|
|||||||
Reference in New Issue
Block a user