docs: generate OAS for v2 (#7883)
This commit is contained in:
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Api Keys
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Campaigns
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Collections
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+16
-8
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Customers
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+16
-8
@@ -28,12 +28,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -52,12 +58,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -73,6 +83,8 @@
|
||||
* tags:
|
||||
* - Customers
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -85,10 +97,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+15
-9
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -69,7 +79,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminFulfillmentSetsDeleteResponse"
|
||||
* $ref: "#/components/schemas/AdminFulfillmentSetDeleteResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -82,10 +92,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+14
-12
@@ -29,12 +29,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -53,12 +59,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -76,10 +86,6 @@
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminServiceZoneDeleteResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -92,10 +98,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+16
-8
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Inventory Items
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+16
-8
@@ -29,12 +29,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -53,12 +59,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -74,6 +84,8 @@
|
||||
* tags:
|
||||
* - Inventory Items
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -86,10 +98,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
* operationId: DeleteInvitesId
|
||||
* summary: Delete a Invite
|
||||
* description: Delete a invite.
|
||||
* x-authenticated: true
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,25 +51,25 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* 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
|
||||
* `-`.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X DELETE '{backend_url}/admin/invites/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* source: curl -X DELETE '{backend_url}/admin/invites/{id}'
|
||||
* tags:
|
||||
* - Invites
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +82,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Price Lists
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+93
@@ -0,0 +1,93 @@
|
||||
/**
|
||||
* @oas [delete] /admin/product-categories/{id}
|
||||
* operationId: DeleteProductCategoriesId
|
||||
* summary: Delete a Product Category
|
||||
* description: Delete a product category.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The product category'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/product-categories/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Product Categories
|
||||
* 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"
|
||||
*
|
||||
*/
|
||||
|
||||
+23
-25
@@ -1,14 +1,13 @@
|
||||
/**
|
||||
* @oas [get] /admin/pricing/rule-types/{id}
|
||||
* operationId: GetPricingRuleTypesId
|
||||
* summary: List Rule Types
|
||||
* description: Retrieve a list of rule types in a pricing. The rule types can be
|
||||
* filtered by fields like FILTER FIELDS. The rule types can also be paginated.
|
||||
* @oas [delete] /admin/product-tags/{id}
|
||||
* operationId: DeleteProductTagsId
|
||||
* summary: Delete a Product Tag
|
||||
* description: Delete a product tag.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The pricing's ID.
|
||||
* description: The product tag's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
@@ -22,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,38 +51,31 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The pricing's fields.
|
||||
* required:
|
||||
* - fields
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/pricing/rule-types/{id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/product-tags/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Pricing
|
||||
* - Product Tags
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Product Types
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,12 @@
|
||||
* tags:
|
||||
* - Products
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminProductDeleteResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +92,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+20
-8
@@ -28,12 +28,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -52,12 +58,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -71,6 +81,12 @@
|
||||
* tags:
|
||||
* - Products
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminProductOptionDeleteResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -83,10 +99,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+20
-8
@@ -28,12 +28,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -52,12 +58,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -71,6 +81,12 @@
|
||||
* tags:
|
||||
* - Products
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminProductVariantDeleteResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -83,10 +99,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+110
@@ -0,0 +1,110 @@
|
||||
/**
|
||||
* @oas [delete] /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}
|
||||
* operationId: DeleteProductsIdVariantsVariant_idInventoryItemsInventory_item_id
|
||||
* summary: Remove Inventory Items from Product
|
||||
* description: Remove a list of inventory items from a product. This doesn't
|
||||
* delete the Inventory Item, only the association between the Inventory Item and
|
||||
* the product.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The product's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: variant_id
|
||||
* in: path
|
||||
* description: The product's variant id.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: inventory_item_id
|
||||
* in: path
|
||||
* description: The product's inventory item 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/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}'
|
||||
* \
|
||||
*
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Products
|
||||
* 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"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Promotions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Regions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Reservations
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -0,0 +1,93 @@
|
||||
/**
|
||||
* @oas [delete] /admin/return-reasons/{id}
|
||||
* operationId: DeleteReturnReasonsId
|
||||
* summary: Delete a Return Reason
|
||||
* description: Delete a return reason.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The return reason's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: expand
|
||||
* in: query
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: expand
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: >-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: >-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* - name: offset
|
||||
* in: query
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* - name: limit
|
||||
* in: query
|
||||
* description: Limit the number of items returned in the list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X DELETE '{backend_url}/admin/return-reasons/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Return Reasons
|
||||
* 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"
|
||||
*
|
||||
*/
|
||||
|
||||
+16
-8
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Sales Channels
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+14
-8
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -82,10 +92,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+14
-8
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -82,10 +92,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+16
-8
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Stock Locations
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Tax Rates
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+16
-8
@@ -28,12 +28,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -52,12 +58,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -71,6 +81,8 @@
|
||||
* tags:
|
||||
* - Tax Rates
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -83,10 +95,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Tax Regions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,12 +51,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,6 +74,8 @@
|
||||
* tags:
|
||||
* - Uploads
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +88,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
* operationId: DeleteUsersId
|
||||
* summary: Delete a User
|
||||
* description: Delete a user.
|
||||
* x-authenticated: true
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
@@ -21,12 +21,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -45,25 +51,25 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* 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
|
||||
* `-`.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X DELETE '{backend_url}/admin/users/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* source: curl -X DELETE '{backend_url}/admin/users/{id}'
|
||||
* tags:
|
||||
* - Users
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -76,10 +82,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -59,6 +69,8 @@
|
||||
* tags:
|
||||
* - Api Keys
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +83,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Api Keys
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -59,6 +69,8 @@
|
||||
* tags:
|
||||
* - Campaigns
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +83,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Campaigns
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -59,6 +69,8 @@
|
||||
* tags:
|
||||
* - Collections
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +83,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Collections
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -59,6 +69,8 @@
|
||||
* tags:
|
||||
* - Currencies
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +83,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Currencies
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -17,12 +17,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -41,12 +47,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -60,6 +70,8 @@
|
||||
* tags:
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -72,10 +84,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -64,7 +74,33 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminCustomerListResponse"
|
||||
* allOf:
|
||||
* - type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The customer's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The customer's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The customer's count.
|
||||
* - type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - customers
|
||||
* properties:
|
||||
* customers:
|
||||
* $ref: "#/components/schemas/AdminCustomer"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +113,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -70,7 +80,13 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminCustomerResponse"
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - customer
|
||||
* properties:
|
||||
* customer:
|
||||
* $ref: "#/components/schemas/AdminCustomer"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -83,10 +99,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+16
-8
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Customers
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+16
-8
@@ -28,12 +28,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -52,12 +58,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -71,6 +81,8 @@
|
||||
* tags:
|
||||
* - Customers
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -83,10 +95,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -59,6 +69,8 @@
|
||||
* tags:
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +83,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+47
-22
@@ -17,12 +17,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -41,42 +47,61 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The fulfillment provider's ID.
|
||||
* - type: array
|
||||
* description: The fulfillment provider's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: is_enabled
|
||||
* in: query
|
||||
* description: The fulfillment provider's is enabled.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: is_enabled
|
||||
* description: The fulfillment provider's is enabled.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The fulfillment provider's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The fulfillment provider's q.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The fulfillment provider's fields.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/fulfillment-providers' \
|
||||
* -H 'x-medusa-access-token: {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "fields": "{value}"
|
||||
* }'
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Fulfillment Providers
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
|
||||
+14
-8
@@ -29,12 +29,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -53,12 +59,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -90,10 +100,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -17,12 +17,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -41,12 +47,275 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The inventory item's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The inventory item's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The inventory item's ID.
|
||||
* - type: array
|
||||
* description: The inventory item's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: sku
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: sku
|
||||
* description: The inventory item's sku.
|
||||
* - type: array
|
||||
* description: The inventory item's sku.
|
||||
* items:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The sku's details.
|
||||
* - name: origin_country
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: origin_country
|
||||
* description: The inventory item's origin country.
|
||||
* - type: array
|
||||
* description: The inventory item's origin country.
|
||||
* items:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The origin country's details.
|
||||
* - name: mid_code
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: mid_code
|
||||
* description: The inventory item's mid code.
|
||||
* - type: array
|
||||
* description: The inventory item's mid code.
|
||||
* items:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The mid code's details.
|
||||
* - name: hs_code
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: hs_code
|
||||
* description: The inventory item's hs code.
|
||||
* - type: array
|
||||
* description: The inventory item's hs code.
|
||||
* items:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The hs code's details.
|
||||
* - name: material
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: material
|
||||
* description: The inventory item's material.
|
||||
* - type: array
|
||||
* description: The inventory item's material.
|
||||
* items:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The material's details.
|
||||
* - name: requires_shipping
|
||||
* in: query
|
||||
* description: The inventory item's requires shipping.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: requires_shipping
|
||||
* description: The inventory item's requires shipping.
|
||||
* - name: weight
|
||||
* in: query
|
||||
* description: The inventory item's weight.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The inventory item's weight.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: length
|
||||
* in: query
|
||||
* description: The inventory item's length.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The inventory item's length.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: height
|
||||
* in: query
|
||||
* description: The inventory item's height.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The inventory item's height.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: width
|
||||
* in: query
|
||||
* description: The inventory item's width.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The inventory item's width.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: location_levels
|
||||
* in: query
|
||||
* description: The inventory item's location levels.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The inventory item's location levels.
|
||||
* properties:
|
||||
* location_id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: location_id
|
||||
* description: The location level's location id.
|
||||
* - type: array
|
||||
* description: The location level's location id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: location_id
|
||||
* description: The location id's details.
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -60,6 +329,8 @@
|
||||
* tags:
|
||||
* - Inventory Items
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -72,10 +343,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Inventory Items
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,18 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The inventory item's fields.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+38
-8
@@ -23,12 +23,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -47,12 +53,38 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: location_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: location_id
|
||||
* description: The inventory item's location id.
|
||||
* - type: array
|
||||
* description: The inventory item's location id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: location_id
|
||||
* description: The location id's details.
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -66,6 +98,8 @@
|
||||
* tags:
|
||||
* - Inventory Items
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -78,10 +112,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
* summary: List Invites
|
||||
* description: Retrieve a list of invites. The invites can be filtered by fields
|
||||
* such as `id`. The invites can also be sorted or paginated.
|
||||
* x-authenticated: true
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: expand
|
||||
* in: query
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,25 +46,170 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The invite's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The invite's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The invite's ID.
|
||||
* - type: array
|
||||
* description: The invite's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: email
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: email
|
||||
* description: The invite's email.
|
||||
* format: email
|
||||
* - type: array
|
||||
* description: The invite's email.
|
||||
* items:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The email's details.
|
||||
* format: email
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The invite's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The invite's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The invite's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The invite's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The invite's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The invite's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/invites' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* source: curl '{backend_url}/admin/invites'
|
||||
* tags:
|
||||
* - Invites
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +222,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
* summary: Get a Invite
|
||||
* description: Retrieve a invite by its ID. You can expand the invite's relations
|
||||
* or select the fields that should be returned.
|
||||
* x-authenticated: true
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,25 +52,25 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* 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
|
||||
* `-`.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/invites/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* source: curl '{backend_url}/admin/invites/{id}'
|
||||
* tags:
|
||||
* - Invites
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +83,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -59,6 +69,8 @@
|
||||
* tags:
|
||||
* - Orders
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +83,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Orders
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,159 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The payment's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The payment's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The payment's ID.
|
||||
* - type: array
|
||||
* description: The payment's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: payment_session_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: payment_session_id
|
||||
* description: The payment's payment session id.
|
||||
* - type: array
|
||||
* description: The payment's payment session id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: payment_session_id
|
||||
* description: The payment session id's details.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The payment's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The payment's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The payment's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The payment's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The payment's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The payment's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -59,6 +212,8 @@
|
||||
* tags:
|
||||
* - Payments
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +226,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Payments
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,18 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The payment's fields.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+46
-8
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,46 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The payment's ID.
|
||||
* - type: array
|
||||
* description: The payment's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: is_enabled
|
||||
* in: query
|
||||
* description: The payment's is enabled.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: is_enabled
|
||||
* description: The payment's is enabled.
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -59,6 +99,8 @@
|
||||
* tags:
|
||||
* - Payments
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +113,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -59,6 +69,8 @@
|
||||
* tags:
|
||||
* - Price Lists
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +83,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Price Lists
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -17,12 +17,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -41,12 +47,219 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The product category's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The product category's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The product category's ID.
|
||||
* - type: array
|
||||
* description: The product category's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: description
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: description
|
||||
* description: The product category's description.
|
||||
* - type: array
|
||||
* description: The product category's description.
|
||||
* items:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The description's details.
|
||||
* - name: handle
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: handle
|
||||
* description: The product category's handle.
|
||||
* - type: array
|
||||
* description: The product category's handle.
|
||||
* items:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The handle's details.
|
||||
* - name: parent_category_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: parent_category_id
|
||||
* description: The product category's parent category id.
|
||||
* - type: array
|
||||
* description: The product category's parent category id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: parent_category_id
|
||||
* description: The parent category id's details.
|
||||
* - name: include_ancestors_tree
|
||||
* in: query
|
||||
* description: The product category's include ancestors tree.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_ancestors_tree
|
||||
* description: The product category's include ancestors tree.
|
||||
* - name: include_descendants_tree
|
||||
* in: query
|
||||
* description: The product category's include descendants tree.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_descendants_tree
|
||||
* description: The product category's include descendants tree.
|
||||
* - name: is_internal
|
||||
* in: query
|
||||
* description: The product category's is internal.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: is_internal
|
||||
* description: The product category's is internal.
|
||||
* - name: is_active
|
||||
* in: query
|
||||
* description: The product category's is active.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: is_active
|
||||
* description: The product category's is active.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The product category's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The product category's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The product category's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The product category's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The product category's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The product category's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -78,10 +291,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+31
-34
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,51 +52,42 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: include_ancestors_tree
|
||||
* in: query
|
||||
* description: The product category's include ancestors tree.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_ancestors_tree
|
||||
* description: The product category's include ancestors tree.
|
||||
* - name: include_descendants_tree
|
||||
* in: query
|
||||
* description: The product category's include descendants tree.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_descendants_tree
|
||||
* description: The product category's include descendants tree.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - fields
|
||||
* - include_ancestors_tree
|
||||
* - include_descendants_tree
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The product category's fields.
|
||||
* include_ancestors_tree:
|
||||
* type: boolean
|
||||
* title: include_ancestors_tree
|
||||
* description: The product category's include ancestors tree.
|
||||
* include_descendants_tree:
|
||||
* type: boolean
|
||||
* title: include_descendants_tree
|
||||
* description: The product category's include descendants tree.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/product-categories/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "fields": "{value}",
|
||||
* "include_ancestors_tree": true,
|
||||
* "include_descendants_tree": true
|
||||
* }'
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Product Categories
|
||||
* responses:
|
||||
|
||||
@@ -0,0 +1,231 @@
|
||||
/**
|
||||
* @oas [get] /admin/product-tags
|
||||
* operationId: GetProductTags
|
||||
* summary: List Product Tags
|
||||
* description: Retrieve a list of product tags. The product tags can be filtered
|
||||
* by fields such as `id`. The product tags can also be sorted or paginated.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: expand
|
||||
* in: query
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: expand
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: >-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: >-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* - name: offset
|
||||
* in: query
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* - name: limit
|
||||
* in: query
|
||||
* description: Limit the number of items returned in the list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The product tag's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The product tag's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The product tag's ID.
|
||||
* - type: array
|
||||
* description: The product tag's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: value
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: value
|
||||
* description: The product tag's value.
|
||||
* - type: array
|
||||
* description: The product tag's value.
|
||||
* items:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The value's details.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The product tag's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The product tag's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The product tag's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The product tag's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The product tag's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The product tag's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/product-tags' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Product Tags
|
||||
* 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"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,94 @@
|
||||
/**
|
||||
* @oas [get] /admin/product-tags/{id}
|
||||
* operationId: GetProductTagsId
|
||||
* summary: Get a Product Tag
|
||||
* description: Retrieve a product tag by its ID. You can expand the product tag's
|
||||
* relations or select the fields that should be returned.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The product tag's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: expand
|
||||
* in: query
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: expand
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: >-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: >-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* - name: offset
|
||||
* in: query
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* - name: limit
|
||||
* in: query
|
||||
* description: Limit the number of items returned in the list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/product-tags/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Product Tags
|
||||
* 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"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,159 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The product type's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The product type's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The product type's ID.
|
||||
* - type: array
|
||||
* description: The product type's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: value
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: value
|
||||
* description: The product type's value.
|
||||
* - type: array
|
||||
* description: The product type's value.
|
||||
* items:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The value's details.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The product type's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The product type's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The product type's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The product type's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The product type's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The product type's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -59,6 +212,8 @@
|
||||
* tags:
|
||||
* - Product Types
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +226,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,42 +52,31 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The product type's fields.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/product-types/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "fields": "{value}"
|
||||
* }'
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Product Types
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,12 @@
|
||||
* tags:
|
||||
* - Products
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminProductResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +93,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+1077
-8
File diff suppressed because it is too large
Load Diff
+20
-8
@@ -28,12 +28,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -52,12 +58,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -71,6 +81,12 @@
|
||||
* tags:
|
||||
* - Products
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminProductOptionResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -83,10 +99,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+49
-8
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,41 @@
|
||||
* tags:
|
||||
* - Products
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* allOf:
|
||||
* - type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The product's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The product's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The product's count.
|
||||
* - type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - variants
|
||||
* properties:
|
||||
* variants:
|
||||
* type: array
|
||||
* description: The product's variants.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminProductVariant"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +122,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+20
-8
@@ -28,12 +28,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -52,12 +58,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -71,6 +81,12 @@
|
||||
* tags:
|
||||
* - Products
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminProductVariantResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -83,10 +99,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,178 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The promotion's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The promotion's q.
|
||||
* - name: code
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: code
|
||||
* description: The promotion's code.
|
||||
* - type: array
|
||||
* description: The promotion's code.
|
||||
* items:
|
||||
* type: string
|
||||
* title: code
|
||||
* description: The code's details.
|
||||
* - name: campaign_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: campaign_id
|
||||
* description: The promotion's campaign id.
|
||||
* - type: array
|
||||
* description: The promotion's campaign id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: campaign_id
|
||||
* description: The campaign id's details.
|
||||
* - name: application_method
|
||||
* in: query
|
||||
* description: The promotion's application method.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The promotion's application method.
|
||||
* properties:
|
||||
* currency_code:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: currency_code
|
||||
* description: The application method's currency code.
|
||||
* - type: array
|
||||
* description: The application method's currency code.
|
||||
* items:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The currency code's details.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The promotion's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The promotion's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The promotion's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The promotion's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The promotion's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The promotion's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -59,6 +231,8 @@
|
||||
* tags:
|
||||
* - Promotions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +245,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,42 +52,31 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The promotion's fields.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/promotions/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "fields": "{value}"
|
||||
* }'
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Promotions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
|
||||
+16
-8
@@ -28,12 +28,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -52,12 +58,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -71,6 +81,8 @@
|
||||
* tags:
|
||||
* - Promotions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -83,10 +95,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+32
-8
@@ -23,12 +23,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -47,12 +53,32 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: promotion_type
|
||||
* in: query
|
||||
* description: The promotion's promotion type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: promotion_type
|
||||
* description: The promotion's promotion type.
|
||||
* - name: application_method_type
|
||||
* in: query
|
||||
* description: The promotion's application method type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: application_method_type
|
||||
* description: The promotion's application method type.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -66,6 +92,8 @@
|
||||
* tags:
|
||||
* - Promotions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -78,10 +106,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+32
-8
@@ -28,12 +28,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -52,12 +58,32 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: promotion_type
|
||||
* in: query
|
||||
* description: The promotion's promotion type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: promotion_type
|
||||
* description: The promotion's promotion type.
|
||||
* - name: application_method_type
|
||||
* in: query
|
||||
* description: The promotion's application method type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: application_method_type
|
||||
* description: The promotion's application method type.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -74,6 +100,8 @@
|
||||
* tags:
|
||||
* - Promotions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -86,10 +114,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,173 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The region's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The region's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The region's ID.
|
||||
* - type: array
|
||||
* description: The region's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: code
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: code
|
||||
* description: The region's code.
|
||||
* - type: array
|
||||
* description: The region's code.
|
||||
* items:
|
||||
* type: string
|
||||
* title: code
|
||||
* description: The code's details.
|
||||
* - name: name
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: name
|
||||
* description: The region's name.
|
||||
* - type: array
|
||||
* description: The region's name.
|
||||
* items:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The name's details.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The region's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The region's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The region's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The region's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The region's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The region's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -59,6 +226,8 @@
|
||||
* tags:
|
||||
* - Regions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +240,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Regions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,18 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The region's fields.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,266 +46,255 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: location_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: location_id
|
||||
* description: The reservation's location id.
|
||||
* - type: array
|
||||
* description: The reservation's location id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: location_id
|
||||
* description: The location id's details.
|
||||
* - name: inventory_item_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: inventory_item_id
|
||||
* description: The reservation's inventory item id.
|
||||
* - type: array
|
||||
* description: The reservation's inventory item id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: inventory_item_id
|
||||
* description: The inventory item id's details.
|
||||
* - name: line_item_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: line_item_id
|
||||
* description: The reservation's line item id.
|
||||
* - type: array
|
||||
* description: The reservation's line item id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: line_item_id
|
||||
* description: The line item id's details.
|
||||
* - name: created_by
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: created_by
|
||||
* description: The reservation's created by.
|
||||
* - type: array
|
||||
* description: The reservation's created by.
|
||||
* items:
|
||||
* type: string
|
||||
* title: created_by
|
||||
* description: The created by's details.
|
||||
* - name: description
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: description
|
||||
* description: The reservation's description.
|
||||
* - type: object
|
||||
* description: The reservation's description.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: quantity
|
||||
* in: query
|
||||
* description: The reservation's quantity.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The reservation's quantity.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The reservation's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The reservation's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The reservation's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The reservation's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The reservation's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The reservation's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - limit
|
||||
* - fields
|
||||
* - order
|
||||
* - offset
|
||||
* - location_id
|
||||
* - inventory_item_id
|
||||
* - line_item_id
|
||||
* - created_by
|
||||
* - description
|
||||
* - quantity
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The reservation's limit.
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The reservation's fields.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The reservation's order.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The reservation's offset.
|
||||
* location_id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: location_id
|
||||
* description: The reservation's location id.
|
||||
* - type: array
|
||||
* description: The reservation's location id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: location_id
|
||||
* description: The location id's details.
|
||||
* inventory_item_id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: inventory_item_id
|
||||
* description: The reservation's inventory item id.
|
||||
* - type: array
|
||||
* description: The reservation's inventory item id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: inventory_item_id
|
||||
* description: The inventory item id's details.
|
||||
* line_item_id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: line_item_id
|
||||
* description: The reservation's line item id.
|
||||
* - type: array
|
||||
* description: The reservation's line item id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: line_item_id
|
||||
* description: The line item id's details.
|
||||
* created_by:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: created_by
|
||||
* description: The reservation's created by.
|
||||
* - type: array
|
||||
* description: The reservation's created by.
|
||||
* items:
|
||||
* type: string
|
||||
* title: created_by
|
||||
* description: The created by's details.
|
||||
* description:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: description
|
||||
* description: The reservation's description.
|
||||
* - type: object
|
||||
* description: The reservation's description.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* quantity:
|
||||
* type: object
|
||||
* description: The reservation's quantity.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* created_at:
|
||||
* type: object
|
||||
* description: The reservation's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* updated_at:
|
||||
* type: object
|
||||
* description: The reservation's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* deleted_at:
|
||||
* type: object
|
||||
* description: The reservation's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/reservations' \
|
||||
* -H 'x-medusa-access-token: {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "limit": 7964169955442688,
|
||||
* "fields": "{value}",
|
||||
* "order": "{value}",
|
||||
* "offset": 3052067430072320,
|
||||
* "quantity": {},
|
||||
* "created_at": {},
|
||||
* "updated_at": {},
|
||||
* "deleted_at": {}
|
||||
* }'
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Reservations
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,42 +52,31 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The reservation's fields.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/reservations/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "fields": "{value}"
|
||||
* }'
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Reservations
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
|
||||
@@ -0,0 +1,89 @@
|
||||
/**
|
||||
* @oas [get] /admin/return-reasons
|
||||
* operationId: GetReturnReasons
|
||||
* summary: List Return Reasons
|
||||
* description: Retrieve a list of return reasons. The return reasons can be
|
||||
* filtered by fields such as `id`. The return reasons can also be sorted or
|
||||
* paginated.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: expand
|
||||
* in: query
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: expand
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: >-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: >-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* - name: offset
|
||||
* in: query
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* - name: limit
|
||||
* in: query
|
||||
* description: Limit the number of items returned in the list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/return-reasons' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Return Reasons
|
||||
* 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"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,94 @@
|
||||
/**
|
||||
* @oas [get] /admin/return-reasons/{id}
|
||||
* operationId: GetReturnReasonsId
|
||||
* summary: Get a Return Reason
|
||||
* description: Retrieve a return reason by its ID. You can expand the return
|
||||
* reason's relations or select the fields that should be returned.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The return reason's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: expand
|
||||
* in: query
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: expand
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: >-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: >-
|
||||
* Comma-separated fields that should be included in the returned data.
|
||||
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* * without prefix it will replace the entire default fields.
|
||||
* - name: offset
|
||||
* in: query
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* - name: limit
|
||||
* in: query
|
||||
* description: Limit the number of items returned in the list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/return-reasons/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Return Reasons
|
||||
* 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"
|
||||
*
|
||||
*/
|
||||
|
||||
+23
-15
@@ -1,9 +1,9 @@
|
||||
/**
|
||||
* @oas [get] /admin/promotions/rule-operator-options
|
||||
* operationId: GetPromotionsRuleOperatorOptions
|
||||
* summary: List Promotions
|
||||
* description: Retrieve a list of promotions. The promotions can be filtered by
|
||||
* fields such as `id`. The promotions can also be sorted or paginated.
|
||||
* @oas [get] /admin/returns
|
||||
* operationId: GetReturns
|
||||
* summary: List Returns
|
||||
* description: Retrieve a list of returns. The returns can be filtered by fields
|
||||
* such as `id`. The returns can also be sorted or paginated.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: expand
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -54,11 +64,13 @@
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/promotions/rule-operator-options' \
|
||||
* curl '{backend_url}/admin/returns' \
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Promotions
|
||||
* - Returns
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +83,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,94 @@
|
||||
/**
|
||||
* @oas [get] /admin/returns/{id}
|
||||
* operationId: GetReturnsId
|
||||
* summary: Get a Return
|
||||
* description: Retrieve a return by its ID. You can expand the return's relations
|
||||
* or select the fields that should be returned.
|
||||
* 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 '{backend_url}/admin/returns/{id}' \
|
||||
* -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"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -17,12 +17,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -41,12 +47,203 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The sales channel's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The sales channel's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The sales channel's ID.
|
||||
* - type: array
|
||||
* description: The sales channel's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: name
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: name
|
||||
* description: The sales channel's name.
|
||||
* - type: array
|
||||
* description: The sales channel's name.
|
||||
* items:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The name's details.
|
||||
* - name: description
|
||||
* in: query
|
||||
* description: The sales channel's description.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The sales channel's description.
|
||||
* - name: is_disabled
|
||||
* in: query
|
||||
* description: The sales channel's is disabled.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: is_disabled
|
||||
* description: The sales channel's is disabled.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The sales channel's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The sales channel's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The sales channel's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The sales channel's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The sales channel's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The sales channel's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: location_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: location_id
|
||||
* description: The sales channel's location id.
|
||||
* - type: array
|
||||
* description: The sales channel's location id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: location_id
|
||||
* description: The location id's details.
|
||||
* - name: publishable_key_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: publishable_key_id
|
||||
* description: The sales channel's publishable key id.
|
||||
* - type: array
|
||||
* description: The sales channel's publishable key id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: publishable_key_id
|
||||
* description: The publishable key id's details.
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -60,6 +257,8 @@
|
||||
* tags:
|
||||
* - Sales Channels
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -72,10 +271,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Sales Channels
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,18 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The sales channel's fields.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -17,12 +17,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -41,57 +47,203 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The shipping option's ID.
|
||||
* - type: array
|
||||
* description: The shipping option's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The shipping option's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The shipping option's q.
|
||||
* - name: service_zone_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: service_zone_id
|
||||
* description: The shipping option's service zone id.
|
||||
* - type: array
|
||||
* description: The shipping option's service zone id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: service_zone_id
|
||||
* description: The service zone id's details.
|
||||
* - name: shipping_profile_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: shipping_profile_id
|
||||
* description: The shipping option's shipping profile id.
|
||||
* - type: array
|
||||
* description: The shipping option's shipping profile id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: shipping_profile_id
|
||||
* description: The shipping profile id's details.
|
||||
* - name: provider_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: provider_id
|
||||
* description: The shipping option's provider id.
|
||||
* - type: array
|
||||
* description: The shipping option's provider id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: provider_id
|
||||
* description: The provider id's details.
|
||||
* - name: shipping_option_type_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: shipping_option_type_id
|
||||
* description: The shipping option's shipping option type id.
|
||||
* - type: array
|
||||
* description: The shipping option's shipping option type id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: shipping_option_type_id
|
||||
* description: The shipping option type id's details.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The shipping option's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The shipping option's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The shipping option's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The shipping option's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The shipping option's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The shipping option's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - fields
|
||||
* - offset
|
||||
* - limit
|
||||
* - order
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The shipping option's fields.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The shipping option's offset.
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The shipping option's limit.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The shipping option's order.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/shipping-options' \
|
||||
* -H 'x-medusa-access-token: {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "fields": "{value}",
|
||||
* "offset": 8788876090933248,
|
||||
* "limit": 2996103177830400,
|
||||
* "order": "{value}"
|
||||
* }'
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Shipping Options
|
||||
* responses:
|
||||
@@ -100,7 +252,36 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminShippingOptionListResponse"
|
||||
* allOf:
|
||||
* - type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The shipping option's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The shipping option's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The shipping option's count.
|
||||
* - type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - shipping_options
|
||||
* properties:
|
||||
* shipping_options:
|
||||
* type: array
|
||||
* description: The shipping option's shipping options.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminShippingOption"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
|
||||
@@ -17,12 +17,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -41,12 +47,161 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The shipping profile's ID.
|
||||
* - type: array
|
||||
* description: The shipping profile's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The shipping profile's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The shipping profile's q.
|
||||
* - name: type
|
||||
* in: query
|
||||
* description: The shipping profile's type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: type
|
||||
* description: The shipping profile's type.
|
||||
* - name: name
|
||||
* in: query
|
||||
* description: The shipping profile's name.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The shipping profile's name.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The shipping profile's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The shipping profile's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The shipping profile's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The shipping profile's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The shipping profile's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The shipping profile's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -65,7 +220,36 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminShippingProfilesResponse"
|
||||
* allOf:
|
||||
* - type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The shipping profile's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The shipping profile's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The shipping profile's count.
|
||||
* - type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - shipping_profiles
|
||||
* properties:
|
||||
* shipping_profiles:
|
||||
* type: array
|
||||
* description: The shipping profile's shipping profiles.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminShippingProfile"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -78,10 +262,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
+15
-22
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,39 +52,26 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* description: The field to sort the data by. By default, the sort order is
|
||||
* ascending. To change the order to descending, prefix the field name with
|
||||
* `-`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The shipping profile's fields.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/shipping-profiles/{id}' \
|
||||
* -H 'x-medusa-access-token: {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "fields": "{value}"
|
||||
* }'
|
||||
* -H 'x-medusa-access-token: {api_token}'
|
||||
* tags:
|
||||
* - Shipping Profiles
|
||||
* responses:
|
||||
|
||||
@@ -17,12 +17,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -41,12 +47,187 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The stock location's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The stock location's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The stock location's ID.
|
||||
* - type: array
|
||||
* description: The stock location's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: name
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: name
|
||||
* description: The stock location's name.
|
||||
* - type: array
|
||||
* description: The stock location's name.
|
||||
* items:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The name's details.
|
||||
* - name: address_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: address_id
|
||||
* description: The stock location's address id.
|
||||
* - type: array
|
||||
* description: The stock location's address id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: address_id
|
||||
* description: The address id's details.
|
||||
* - name: sales_channel_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: sales_channel_id
|
||||
* description: The stock location's sales channel id.
|
||||
* - type: array
|
||||
* description: The stock location's sales channel id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: The sales channel id's details.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The stock location's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The stock location's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The stock location's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The stock location's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The stock location's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The stock location's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -60,6 +241,8 @@
|
||||
* tags:
|
||||
* - Stock Locations
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -72,10 +255,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Stock Locations
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,19 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The stock location's fields.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,60 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The store's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The store's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The store's ID.
|
||||
* - type: array
|
||||
* description: The store's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: name
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: name
|
||||
* description: The store's name.
|
||||
* - type: array
|
||||
* description: The store's name.
|
||||
* items:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The name's details.
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -59,6 +113,8 @@
|
||||
* tags:
|
||||
* - Stores
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +127,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Stores
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,18 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The store's fields.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,181 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The tax rate's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The tax rate's q.
|
||||
* - name: tax_region_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: tax_region_id
|
||||
* description: The tax rate's tax region id.
|
||||
* - type: array
|
||||
* description: The tax rate's tax region id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: tax_region_id
|
||||
* description: The tax region id's details.
|
||||
* - type: object
|
||||
* description: The tax rate's tax region id.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: is_default
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* enum:
|
||||
* - "true"
|
||||
* - "false"
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The tax rate's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The tax rate's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The tax rate's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The tax rate's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The tax rate's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The tax rate's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -59,6 +234,8 @@
|
||||
* tags:
|
||||
* - Tax Rates
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +248,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Tax Rates
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,18 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - fields
|
||||
* properties:
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The tax rate's fields.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,12 +16,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -40,12 +46,285 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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
|
||||
* `-`.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The tax region's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The tax region's q.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The tax region's ID.
|
||||
* - type: array
|
||||
* description: The tax region's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: country_code
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: country_code
|
||||
* description: The tax region's country code.
|
||||
* - type: array
|
||||
* description: The tax region's country code.
|
||||
* items:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The country code's details.
|
||||
* - type: object
|
||||
* description: The tax region's country code.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: province_code
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: province_code
|
||||
* description: The tax region's province code.
|
||||
* - type: array
|
||||
* description: The tax region's province code.
|
||||
* items:
|
||||
* type: string
|
||||
* title: province_code
|
||||
* description: The province code's details.
|
||||
* - type: object
|
||||
* description: The tax region's province code.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: parent_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: parent_id
|
||||
* description: The tax region's parent id.
|
||||
* - type: array
|
||||
* description: The tax region's parent id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: parent_id
|
||||
* description: The parent id's details.
|
||||
* - type: object
|
||||
* description: The tax region's parent id.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: created_by
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: created_by
|
||||
* description: The tax region's created by.
|
||||
* - type: array
|
||||
* description: The tax region's created by.
|
||||
* items:
|
||||
* type: string
|
||||
* title: created_by
|
||||
* description: The created by's details.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The tax region's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The tax region's created at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The tax region's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The tax region's updated at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The tax region's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The tax region's deleted at.
|
||||
* required:
|
||||
* - $eq
|
||||
* - $ne
|
||||
* - $in
|
||||
* - $nin
|
||||
* - $like
|
||||
* - $ilike
|
||||
* - $re
|
||||
* - $contains
|
||||
* - $gt
|
||||
* - $gte
|
||||
* - $lt
|
||||
* - $lte
|
||||
* properties:
|
||||
* $eq: {}
|
||||
* $ne: {}
|
||||
* $in: {}
|
||||
* $nin: {}
|
||||
* $like: {}
|
||||
* $ilike: {}
|
||||
* $re: {}
|
||||
* $contains: {}
|
||||
* $gt: {}
|
||||
* $gte: {}
|
||||
* $lt: {}
|
||||
* $lte: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -59,6 +338,8 @@
|
||||
* tags:
|
||||
* - Tax Regions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -71,10 +352,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -22,12 +22,18 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -46,12 +52,16 @@
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* 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: Field to sort items in the list by.
|
||||
* 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: []
|
||||
@@ -65,6 +75,8 @@
|
||||
* tags:
|
||||
* - Tax Regions
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -77,10 +89,6 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user