chore(docs): Fix docblock-generator OAS tool's max-stack error (#7246)

* regenerate oas to fix duplicate keys

* fix clean:oas script

* fix max-stack errors

* fix max-level condition
This commit is contained in:
Shahed Nasser
2024-05-06 13:41:59 +03:00
committed by GitHub
parent b39de05535
commit 7b2879d643
187 changed files with 7495 additions and 11011 deletions

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -26,6 +66,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminFulfillmentSetsDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -38,6 +82,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -19,6 +19,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -36,6 +76,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminServiceZoneDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -48,6 +92,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -24,8 +64,6 @@
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -38,6 +76,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -24,8 +64,6 @@
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -38,6 +76,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -26,6 +66,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminShippingOptionDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -38,6 +82,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -26,6 +66,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminShippingProfileDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -38,6 +82,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -24,8 +64,6 @@
* tags:
* - Uploads
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -38,6 +76,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -63,7 +63,8 @@
* description: OK
* content:
* application/json:
* schema: {}
* schema:
* $ref: "#/components/schemas/AdminCustomerListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -69,7 +69,8 @@
* description: OK
* content:
* application/json:
* schema: {}
* schema:
* $ref: "#/components/schemas/AdminCustomerResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -5,7 +5,47 @@
* description: Retrieve a list of draft orders. The draft orders can be filtered
* by fields such as `id`. The draft orders can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -19,8 +59,6 @@
* tags:
* - Draft Orders
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -33,6 +71,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -12,6 +12,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -25,8 +65,6 @@
* tags:
* - Draft Orders
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -39,6 +77,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -6,7 +6,47 @@
* can be filtered by fields such as `id`. The fulfillment providers can also be
* sorted or paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -37,8 +77,6 @@
* tags:
* - Fulfillment Providers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -19,6 +19,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -34,6 +74,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminServiceZoneResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -46,6 +90,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -13,6 +13,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -26,8 +66,6 @@
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -40,6 +78,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -5,7 +5,47 @@
* description: Retrieve a list of orders. The orders can be filtered by fields
* such as `id`. The orders can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -19,8 +59,6 @@
* tags:
* - Orders
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -33,6 +71,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -12,6 +12,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -25,8 +65,6 @@
* tags:
* - Orders
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -39,6 +77,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -5,7 +5,47 @@
* description: Retrieve a list of payments. The payments can be filtered by fields
* such as `id`. The payments can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -19,8 +59,6 @@
* tags:
* - Payments
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -33,6 +71,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -6,7 +6,47 @@
* be filtered by fields such as `id`. The product categories can also be sorted
* or paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -22,6 +62,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductCategoryListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -34,6 +78,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -12,6 +12,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -56,6 +96,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductCategoryResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -5,7 +5,47 @@
* description: Retrieve a list of product types. The product types can be filtered
* by fields such as `id`. The product types can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -19,8 +59,6 @@
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -33,6 +71,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -82,8 +82,6 @@
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -62,19 +62,23 @@
* schema:
* type: object
* description: SUMMARY
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The promotion's fields.
* required:
* - fields
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/promotions/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "fields": "{value}"
* }'
* tags:
* - Promotions
* responses:
@@ -90,11 +94,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminGetPromotionsParams"
*
*/

View File

@@ -18,6 +18,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -31,8 +71,6 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -45,6 +83,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -13,6 +13,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -26,8 +66,6 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -40,6 +78,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -5,7 +5,47 @@
* description: Retrieve a list of promotions. The promotions can be filtered by
* fields such as `id`. The promotions can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -19,8 +59,6 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -33,6 +71,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -18,6 +18,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -34,8 +74,6 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -48,6 +86,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -5,7 +5,47 @@
* description: Retrieve a list of reservations. The reservations can be filtered
* by fields such as `id`. The reservations can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -260,8 +300,6 @@
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -82,8 +82,6 @@
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -6,7 +6,47 @@
* filtered by fields such as `id`. The shipping options can also be sorted or
* paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -57,6 +97,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminShippingOptionListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -6,7 +6,47 @@
* filtered by fields such as `id`. The shipping profiles can also be sorted or
* paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -22,6 +62,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminShippingProfilesResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -34,6 +78,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -12,6 +12,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -44,6 +84,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminShippingProfileResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -6,7 +6,47 @@
* filtered by fields such as `id`. The stock locations can also be sorted or
* paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -20,8 +60,6 @@
* tags:
* - Stock Locations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -34,6 +72,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -12,6 +12,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []

View File

@@ -5,7 +5,47 @@
* description: Retrieve a list of tax regions. The tax regions can be filtered by
* fields such as `id`. The tax regions can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -19,8 +59,6 @@
* tags:
* - Tax Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -33,6 +71,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -12,6 +12,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -25,8 +65,6 @@
* tags:
* - Tax Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -39,6 +77,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -12,6 +12,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -25,8 +65,6 @@
* tags:
* - Uploads
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -39,6 +77,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/

View File

@@ -53,7 +53,21 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateApiKey"
* type: object
* description: SUMMARY
* required:
* - title
* - type
* properties:
* title:
* type: string
* title: title
* description: The api key's title.
* type:
* type: string
* enum:
* - publishable
* - secret
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -80,20 +94,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - title
* - type
* properties:
* title:
* type: string
* title: title
* description: The api key's title.
* type: {}
*
*/

View File

@@ -59,13 +59,25 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/UpdateApiKey"
* type: object
* description: SUMMARY
* required:
* - title
* properties:
* title:
* type: string
* title: title
* description: The api key's title.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/api-keys/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "title": "{value}"
* }'
* tags:
* - Api Keys
* responses:
@@ -81,18 +93,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - title
* properties:
* title:
* type: string
* title: title
* description: The api key's title.
*
*/

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -45,8 +85,6 @@
* tags:
* - Api Keys
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -53,40 +53,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateCampaign"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/campaigns' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "name": "Elwin",
* "campaign_identifier": "{value}",
* "starts_at": "2024-11-30T18:47:00.491Z",
* "ends_at": "2025-02-26T07:41:34.259Z"
* }'
* tags:
* - Campaigns
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - name
* - campaign_identifier
@@ -120,7 +88,11 @@
* - type
* - limit
* properties:
* type: {}
* type:
* type: string
* enum:
* - spend
* - usage
* limit:
* type: number
* title: limit
@@ -148,6 +120,45 @@
* type: string
* title: id
* description: The promotion's ID.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/campaigns' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "name": "Rafael",
* "campaign_identifier": "{value}",
* "description": "{value}",
* "currency": "NZD",
* "budget": {
* "type": "{value}",
* "limit": 1649671080509440
* },
* "starts_at": "2024-12-08T08:39:28.574Z",
* "ends_at": "2024-11-29T15:05:33.749Z",
* "promotions": [
* {
* "id": "id_HXbttvFHpooW0"
* }
* ]
* }'
* tags:
* - Campaigns
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -95,6 +95,7 @@
* enum:
* - spend
* - usage
* type: string
* limit:
* type: number
* title: limit

View File

@@ -53,37 +53,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateProductCollection"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/collections' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "title": "{value}"
* }'
* tags:
* - Collections
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - title
* - handle
@@ -101,6 +72,33 @@
* type: object
* description: The collection's metadata.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/collections' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "title": "{value}",
* "handle": "{value}",
* "metadata": {}
* }'
* tags:
* - Collections
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -59,33 +59,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/UpdateProductCollection"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/collections/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Collections
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - title
* - handle
@@ -103,6 +78,33 @@
* type: object
* description: The collection's metadata.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/collections/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "title": "{value}",
* "handle": "{value}",
* "metadata": {}
* }'
* tags:
* - Collections
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -45,8 +85,6 @@
* tags:
* - Collections
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -53,7 +53,15 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateCustomerGroup"
* type: object
* description: SUMMARY
* required:
* - name
* properties:
* name:
* type: string
* title: name
* description: The customer group's name.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -62,7 +70,7 @@
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "name": "Dave"
* "name": "Garett"
* }'
* tags:
* - Customer Groups
@@ -79,18 +87,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - name
* properties:
* name:
* type: string
* title: name
* description: The customer group's name.
*
*/

View File

@@ -59,13 +59,25 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CustomerGroupUpdatableFields"
* type: object
* description: SUMMARY
* required:
* - name
* properties:
* name:
* type: string
* title: name
* description: The customer group's name.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customer-groups/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "name": "Wilber"
* }'
* tags:
* - Customer Groups
* responses:
@@ -81,18 +93,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - name
* properties:
* name:
* type: string
* title: name
* description: The customer group's name.
*
*/

View File

@@ -85,8 +85,6 @@
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -53,44 +53,15 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateCustomer"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema: {}
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - email
* - company_name
* - first_name
* - last_name
* - phone
* - metadata
* properties:
* email:
* type: string
@@ -113,6 +84,46 @@
* type: string
* title: phone
* description: The customer's phone.
* metadata:
* type: object
* description: The customer's metadata.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "email": "Federico_Kirlin23@yahoo.com",
* "company_name": "{value}",
* "first_name": "{value}",
* "last_name": "{value}",
* "phone": "{value}",
* "metadata": {}
* }'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCustomerResponse"
* "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"
*
*/

View File

@@ -59,44 +59,15 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CustomerUpdatableFields"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema: {}
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - email
* - company_name
* - first_name
* - last_name
* - phone
* - metadata
* properties:
* email:
* type: string
@@ -119,6 +90,46 @@
* type: string
* title: phone
* description: The customer's phone.
* metadata:
* type: object
* description: The customer's metadata.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "email": "Esteban24@hotmail.com",
* "company_name": "{value}",
* "first_name": "{value}",
* "last_name": "{value}",
* "phone": "{value}",
* "metadata": {}
* }'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCustomerResponse"
* "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"
*
*/

View File

@@ -59,37 +59,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateCustomerAddress"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers/{id}/addresses' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "customer_id": "{value}"
* }'
* tags:
* - Customers
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - address_name
* - is_default_shipping
@@ -162,6 +133,44 @@
* type: object
* description: The customer's metadata.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers/{id}/addresses' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "address_name": "{value}",
* "is_default_shipping": true,
* "is_default_billing": true,
* "company": "{value}",
* "first_name": "{value}",
* "last_name": "{value}",
* "address_1": "{value}",
* "address_2": "{value}",
* "city": "{value}",
* "country_code": "{value}",
* "province": "{value}",
* "postal_code": "{value}",
* "phone": "{value}",
* "metadata": {}
* }'
* tags:
* - Customers
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -65,33 +65,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CustomerAddress"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers/{id}/addresses/{address_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - address_name
* - is_default_shipping
@@ -164,6 +139,44 @@
* type: object
* description: The customer's metadata.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers/{id}/addresses/{address_id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "address_name": "{value}",
* "is_default_shipping": false,
* "is_default_billing": true,
* "company": "{value}",
* "first_name": "{value}",
* "last_name": "{value}",
* "address_1": "{value}",
* "address_2": "{value}",
* "city": "{value}",
* "country_code": "{value}",
* "province": "{value}",
* "postal_code": "{value}",
* "phone": "{value}",
* "metadata": {}
* }'
* tags:
* - Customers
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -4,7 +4,47 @@
* summary: Create Draft Order
* description: Create a draft order.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -375,8 +415,6 @@
* tags:
* - Draft Orders
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -154,8 +194,6 @@
* tags:
* - Fulfillment Sets
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -17,6 +17,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -186,6 +226,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminFulfillmentSetResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -4,7 +4,47 @@
* summary: Create Fulfillment
* description: Create a fulfillment.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -207,8 +247,6 @@
* tags:
* - Fulfillments
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -71,8 +71,6 @@
* tags:
* - Fulfillments
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -66,8 +106,6 @@
* tags:
* - Fulfillments
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []

View File

@@ -17,6 +17,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []

View File

@@ -66,8 +66,6 @@
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -80,6 +78,61 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* create:
* type: array
* description: The inventory item's create.
* items:
* type: object
* description: The create's details.
* required:
* - location_id
* - stocked_quantity
* - incoming_quantity
* properties:
* location_id:
* type: string
* title: location_id
* description: The create's location id.
* stocked_quantity:
* type: number
* title: stocked_quantity
* description: The create's stocked quantity.
* incoming_quantity:
* type: number
* title: incoming_quantity
* description: The create's incoming quantity.
* update:
* type: array
* description: The inventory item's update.
* items:
* type: object
* description: The update's details.
* required:
* - stocked_quantity
* - incoming_quantity
* properties:
* stocked_quantity:
* type: number
* title: stocked_quantity
* description: The update's stocked quantity.
* incoming_quantity:
* type: number
* title: incoming_quantity
* description: The update's incoming quantity.
* delete:
* type: array
* description: The inventory item's delete.
* items:
* type: string
* title: delete
* description: The delete's details.
*
*/

View File

@@ -53,7 +53,16 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateInvite"
* type: object
* description: SUMMARY
* required:
* - email
* properties:
* email:
* type: string
* title: email
* description: The invite's email.
* format: email
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -62,7 +71,7 @@
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "email": "Nola57@hotmail.com"
* "email": "Abdiel5@gmail.com"
* }'
* tags:
* - Invites
@@ -79,19 +88,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - email
* properties:
* email:
* type: string
* title: email
* description: The invite's email.
* format: email
*
*/

View File

@@ -85,10 +85,12 @@
* enum:
* - active
* - draft
* type: string
* type:
* enum:
* - sale
* - override
* type: string
* prices:
* type: array
* description: The price list's prices.

View File

@@ -90,10 +90,12 @@
* enum:
* - active
* - draft
* type: string
* type:
* enum:
* - sale
* - override
* type: string
* rules:
* type: object
* description: The price list's rules.

View File

@@ -64,8 +64,6 @@
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -78,6 +76,101 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* create:
* type: array
* description: The price list's create.
* items:
* type: object
* description: The create's details.
* required:
* - currency_code
* - amount
* - variant_id
* - min_quantity
* - max_quantity
* - rules
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The create's currency code.
* amount:
* type: number
* title: amount
* description: The create's amount.
* variant_id:
* type: string
* title: variant_id
* description: The create's variant id.
* min_quantity:
* type: number
* title: min_quantity
* description: The create's min quantity.
* max_quantity:
* type: number
* title: max_quantity
* description: The create's max quantity.
* rules:
* type: object
* description: The create's rules.
* properties: {}
* update:
* type: array
* description: The price list's update.
* items:
* type: object
* description: The update's details.
* required:
* - id
* - currency_code
* - amount
* - variant_id
* - min_quantity
* - max_quantity
* - rules
* properties:
* id:
* type: string
* title: id
* description: The update's ID.
* currency_code:
* type: string
* title: currency_code
* description: The update's currency code.
* amount:
* type: number
* title: amount
* description: The update's amount.
* variant_id:
* type: string
* title: variant_id
* description: The update's variant id.
* min_quantity:
* type: number
* title: min_quantity
* description: The update's min quantity.
* max_quantity:
* type: number
* title: max_quantity
* description: The update's max quantity.
* rules:
* type: object
* description: The update's rules.
* properties: {}
* delete:
* type: array
* description: The price list's delete.
* items:
* type: string
* title: delete
* description: The delete's details.
*
*/

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -45,8 +85,6 @@
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -4,7 +4,47 @@
* summary: Create Product Category
* description: Create a product category.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -79,6 +119,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductCategoryResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -85,6 +125,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductCategoryResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -26,6 +66,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminProductCategoryResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -38,6 +82,27 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* add:
* type: array
* description: The product category's add.
* items:
* type: string
* title: add
* description: The add's details.
* remove:
* type: array
* description: The product category's remove.
* items:
* type: string
* title: remove
* description: The remove's details.
*
*/

View File

@@ -4,7 +4,47 @@
* summary: Create Product Type
* description: Create a product type.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -41,8 +81,6 @@
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -47,8 +87,6 @@
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -53,37 +53,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateProduct"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/products' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "title": "{value}"
* }'
* tags:
* - Products
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - title
* - subtitle
@@ -152,7 +123,13 @@
* type: string
* title: handle
* description: The product's handle.
* status: {}
* status:
* type: string
* enum:
* - draft
* - proposed
* - published
* - rejected
* type_id:
* type: string
* title: type_id
@@ -394,6 +371,109 @@
* type: object
* description: The product's metadata.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/products' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "title": "{value}",
* "subtitle": "{value}",
* "description": "{value}",
* "is_giftcard": false,
* "discountable": false,
* "images": [
* {
* "url": "{value}"
* }
* ],
* "thumbnail": "{value}",
* "handle": "{value}",
* "status": "{value}",
* "type_id": "{value}",
* "collection_id": "{value}",
* "categories": [
* {
* "id": "id_Pb7xedYA7ZAv6g6j54ew"
* }
* ],
* "tags": [
* {
* "id": "id_oDxag4mAGc8CJc",
* "value": "{value}"
* }
* ],
* "options": [
* {
* "title": "{value}",
* "values": [
* "{value}"
* ]
* }
* ],
* "variants": [
* {
* "title": "{value}",
* "sku": "{value}",
* "ean": "{value}",
* "upc": "{value}",
* "barcode": "{value}",
* "hs_code": "{value}",
* "mid_code": "{value}",
* "inventory_quantity": 1351101225893888,
* "allow_backorder": true,
* "manage_inventory": true,
* "variant_rank": 7155606282567680,
* "weight": 4684377097240576,
* "length": 8061605384290304,
* "height": 977445643616256,
* "width": 6708177689116672,
* "origin_country": "{value}",
* "material": "{value}",
* "metadata": {},
* "prices": [
* {
* "currency_code": "{value}",
* "amount": 4139683418210304,
* "min_quantity": 8440994678702080,
* "max_quantity": 5266280927985664
* }
* ],
* "options": {}
* }
* ],
* "sales_channels": [
* {
* "id": "id_WJNcwOGY7glMp"
* }
* ],
* "weight": 8634028928270336,
* "length": 2270965595635712,
* "height": 216881319378944,
* "width": 7665967272296448,
* "hs_code": "{value}",
* "mid_code": "{value}",
* "origin_country": "{value}",
* "material": "{value}",
* "metadata": {}
* }'
* tags:
* - Products
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -59,33 +59,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/UpdateProduct"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/products/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - length
* - description
@@ -405,7 +380,118 @@
* type: boolean
* title: manage_inventory
* description: The variant's manage inventory.
* status: {}
* status:
* type: string
* enum:
* - draft
* - proposed
* - published
* - rejected
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/products/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "length": 3282567029587968,
* "description": "{value}",
* "handle": "{value}",
* "metadata": {},
* "hs_code": "{value}",
* "weight": 4215232060719104,
* "height": 6855525188763648,
* "width": 6565860296622080,
* "origin_country": "{value}",
* "mid_code": "{value}",
* "material": "{value}",
* "thumbnail": "{value}",
* "collection_id": "{value}",
* "tags": [
* {
* "id": "id_ufkiM27SGLcGKiI9fx7h",
* "value": "{value}"
* }
* ],
* "type_id": "{value}",
* "subtitle": "{value}",
* "images": [
* {
* "url": "{value}"
* }
* ],
* "categories": [
* {
* "id": "id_Je6uOboEms3Pkb0s14SZ"
* }
* ],
* "sales_channels": [
* {
* "id": "id_ttuXRM0VhnlxO0tg061"
* }
* ],
* "title": "{value}",
* "discountable": true,
* "options": [
* {
* "id": "id_2B9lNIRdze",
* "title": "{value}",
* "values": [
* "{value}"
* ]
* }
* ],
* "variants": [
* {
* "length": 7973681567367168,
* "options": {},
* "metadata": {},
* "sku": "{value}",
* "barcode": "{value}",
* "hs_code": "{value}",
* "weight": 815881462480896,
* "height": 3071682140962816,
* "width": 1867897194414080,
* "origin_country": "{value}",
* "mid_code": "{value}",
* "material": "{value}",
* "ean": "{value}",
* "upc": "{value}",
* "variant_rank": 6253314014445568,
* "id": "id_QiUPVfomSLnRRU",
* "title": "{value}",
* "prices": [
* {
* "id": "id_KIf1hFOhE2",
* "currency_code": "{value}",
* "amount": 7111166155292672,
* "min_quantity": 7445498468237312,
* "max_quantity": 7312473510117376
* }
* ],
* "inventory_quantity": 3277737491955712,
* "allow_backorder": false,
* "manage_inventory": true
* }
* ],
* "status": "{value}"
* }'
* tags:
* - Products
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -59,7 +59,23 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateProductOption"
* type: object
* description: SUMMARY
* required:
* - title
* - values
* properties:
* title:
* type: string
* title: title
* description: The product's title.
* values:
* type: array
* description: The product's values.
* items:
* type: string
* title: values
* description: The value's values.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -68,7 +84,10 @@
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "title": "{value}"
* "title": "{value}",
* "values": [
* "{value}"
* ]
* }'
* tags:
* - Products
@@ -85,26 +104,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - title
* - values
* properties:
* title:
* type: string
* title: title
* description: The product's title.
* values:
* type: array
* description: The product's values.
* items:
* type: string
* title: values
* description: The value's values.
*
*/

View File

@@ -65,37 +65,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/UpdateProductOption"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/products/{id}/options/{option_id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "id": "id_qX5S6JHjRp0fKV"
* }'
* tags:
* - Products
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - title
@@ -116,6 +87,35 @@
* type: string
* title: values
* description: The value's values.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/products/{id}/options/{option_id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "id": "id_BdxJWBRNOp",
* "title": "{value}",
* "values": [
* "{value}"
* ]
* }'
* tags:
* - Products
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -59,37 +59,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateProductVariant"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/products/{id}/variants' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "title": "{value}"
* }'
* tags:
* - Products
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - title
* - sku
@@ -216,6 +187,57 @@
* type: object
* description: The product's options.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/products/{id}/variants' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "title": "{value}",
* "sku": "{value}",
* "ean": "{value}",
* "upc": "{value}",
* "barcode": "{value}",
* "hs_code": "{value}",
* "mid_code": "{value}",
* "inventory_quantity": 3621544083324928,
* "allow_backorder": false,
* "manage_inventory": true,
* "variant_rank": 849570489696256,
* "weight": 7893319220723712,
* "length": 2949835917361152,
* "height": 2357674687594496,
* "width": 5150499311452160,
* "origin_country": "{value}",
* "material": "{value}",
* "metadata": {},
* "prices": [
* {
* "currency_code": "{value}",
* "amount": 8952600449777664,
* "min_quantity": 5462512040411136,
* "max_quantity": 4871260370632704
* }
* ],
* "options": {}
* }'
* tags:
* - Products
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -65,37 +65,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/UpdateProductVariant"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "id": "id_fa9NxfjmFAz"
* }'
* tags:
* - Products
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - length
* - options
@@ -232,6 +203,59 @@
* type: boolean
* title: manage_inventory
* description: The product's manage inventory.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "length": 553333433565184,
* "options": {},
* "metadata": {},
* "sku": "{value}",
* "barcode": "{value}",
* "hs_code": "{value}",
* "weight": 110229628911616,
* "height": 4172081795170304,
* "width": 2991320977113088,
* "origin_country": "{value}",
* "mid_code": "{value}",
* "material": "{value}",
* "ean": "{value}",
* "upc": "{value}",
* "variant_rank": 3522258324684800,
* "id": "id_bPPvwOwWIa2ndex",
* "title": "{value}",
* "prices": [
* {
* "id": "id_gGmeMrUwBNt",
* "currency_code": "{value}",
* "amount": 4572898136162304,
* "min_quantity": 6709305447284736,
* "max_quantity": 2556752140697600
* }
* ],
* "inventory_quantity": 7991114464231424,
* "allow_backorder": false,
* "manage_inventory": true
* }'
* tags:
* - Products
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -24,8 +64,6 @@
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -38,6 +76,463 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* create:
* type: array
* description: The product's create.
* items:
* type: object
* description: The create's details.
* required:
* - title
* - subtitle
* - description
* - is_giftcard
* - discountable
* - images
* - thumbnail
* - handle
* - status
* - type_id
* - collection_id
* - categories
* - tags
* - options
* - variants
* - sales_channels
* - weight
* - length
* - height
* - width
* - hs_code
* - mid_code
* - origin_country
* - material
* - metadata
* properties:
* title:
* type: string
* title: title
* description: The create's title.
* subtitle:
* type: string
* title: subtitle
* description: The create's subtitle.
* description:
* type: string
* title: description
* description: The create's description.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The create's is giftcard.
* discountable:
* type: boolean
* title: discountable
* description: The create's discountable.
* images:
* type: array
* description: The create's images.
* items:
* type: object
* description: The image's images.
* required:
* - url
* properties:
* url:
* type: string
* title: url
* description: The image's url.
* thumbnail:
* type: string
* title: thumbnail
* description: The create's thumbnail.
* handle:
* type: string
* title: handle
* description: The create's handle.
* status:
* type: string
* enum:
* - draft
* - proposed
* - published
* - rejected
* type_id:
* type: string
* title: type_id
* description: The create's type id.
* collection_id:
* type: string
* title: collection_id
* description: The create's collection id.
* categories:
* type: array
* description: The create's categories.
* items:
* type: object
* description: The category's categories.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The category's ID.
* tags:
* type: array
* description: The create's tags.
* items:
* type: object
* description: The tag's tags.
* required:
* - id
* - value
* properties:
* id:
* type: string
* title: id
* description: The tag's ID.
* value:
* type: string
* title: value
* description: The tag's value.
* options:
* type: array
* description: The create's options.
* items:
* type: object
* description: The option's options.
* required:
* - title
* - values
* properties:
* title:
* type: string
* title: title
* description: The option's title.
* values:
* type: array
* description: The option's values.
* items:
* type: string
* title: values
* description: The value's values.
* variants:
* type: array
* description: The create's variants.
* items:
* type: object
* description: The variant's variants.
* required:
* - title
* - sku
* - ean
* - upc
* - barcode
* - hs_code
* - mid_code
* - inventory_quantity
* - allow_backorder
* - manage_inventory
* - variant_rank
* - weight
* - length
* - height
* - width
* - origin_country
* - material
* - metadata
* - prices
* - options
* properties:
* title:
* type: string
* title: title
* description: The variant's title.
* sku:
* type: string
* title: sku
* description: The variant's sku.
* ean:
* type: string
* title: ean
* description: The variant's ean.
* upc:
* type: string
* title: upc
* description: The variant's upc.
* barcode:
* type: string
* title: barcode
* description: The variant's barcode.
* hs_code:
* type: string
* title: hs_code
* description: The variant's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The variant's mid code.
* inventory_quantity:
* type: number
* title: inventory_quantity
* description: The variant's inventory quantity.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The variant's allow backorder.
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The variant's manage inventory.
* variant_rank:
* type: number
* title: variant_rank
* description: The variant's variant rank.
* weight:
* type: number
* title: weight
* description: The variant's weight.
* length:
* type: number
* title: length
* description: The variant's length.
* height:
* type: number
* title: height
* description: The variant's height.
* width:
* type: number
* title: width
* description: The variant's width.
* origin_country:
* type: string
* title: origin_country
* description: The variant's origin country.
* material:
* type: string
* title: material
* description: The variant's material.
* metadata:
* type: object
* description: The variant's metadata.
* properties: {}
* prices:
* type: array
* description: The variant's prices.
* items:
* type: object
* description: The price's prices.
* properties: {}
* options:
* type: object
* description: The variant's options.
* properties: {}
* sales_channels:
* type: array
* description: The create's sales channels.
* items:
* type: object
* description: The sales channel's sales channels.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The sales channel's ID.
* weight:
* type: number
* title: weight
* description: The create's weight.
* length:
* type: number
* title: length
* description: The create's length.
* height:
* type: number
* title: height
* description: The create's height.
* width:
* type: number
* title: width
* description: The create's width.
* hs_code:
* type: string
* title: hs_code
* description: The create's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The create's mid code.
* origin_country:
* type: string
* title: origin_country
* description: The create's origin country.
* material:
* type: string
* title: material
* description: The create's material.
* metadata:
* type: object
* description: The create's metadata.
* properties: {}
* update:
* type: array
* description: The product's update.
* items:
* type: object
* description: The update's details.
* required:
* - title
* - length
* - options
* - metadata
* - sku
* - barcode
* - hs_code
* - weight
* - height
* - width
* - origin_country
* - mid_code
* - material
* - prices
* - manage_inventory
* - allow_backorder
* - ean
* - upc
* - inventory_quantity
* - variant_rank
* - id
* properties:
* title:
* type: string
* title: title
* description: The update's title.
* length:
* type: number
* title: length
* description: The update's length.
* options:
* type: object
* description: The update's options.
* properties: {}
* metadata:
* type: object
* description: The update's metadata.
* properties: {}
* sku:
* type: string
* title: sku
* description: The update's sku.
* barcode:
* type: string
* title: barcode
* description: The update's barcode.
* hs_code:
* type: string
* title: hs_code
* description: The update's hs code.
* weight:
* type: number
* title: weight
* description: The update's weight.
* height:
* type: number
* title: height
* description: The update's height.
* width:
* type: number
* title: width
* description: The update's width.
* origin_country:
* type: string
* title: origin_country
* description: The update's origin country.
* mid_code:
* type: string
* title: mid_code
* description: The update's mid code.
* material:
* type: string
* title: material
* description: The update's material.
* prices:
* type: array
* description: The update's prices.
* items:
* type: object
* description: The price's prices.
* required:
* - id
* - currency_code
* - amount
* - min_quantity
* - max_quantity
* properties:
* id:
* type: string
* title: id
* description: The price's ID.
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* amount:
* type: number
* title: amount
* description: The price's amount.
* min_quantity:
* type: number
* title: min_quantity
* description: The price's min quantity.
* max_quantity:
* type: number
* title: max_quantity
* description: The price's max quantity.
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The update's manage inventory.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The update's allow backorder.
* ean:
* type: string
* title: ean
* description: The update's ean.
* upc:
* type: string
* title: upc
* description: The update's upc.
* inventory_quantity:
* type: number
* title: inventory_quantity
* description: The update's inventory quantity.
* variant_rank:
* type: number
* title: variant_rank
* description: The update's variant rank.
* id:
* type: string
* title: id
* description: The update's ID.
* delete:
* type: array
* description: The product's delete.
* items:
* type: string
* title: delete
* description: The delete's details.
*
*/

View File

@@ -4,7 +4,47 @@
* summary: Create Product
* description: Create a product.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -18,8 +58,6 @@
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -32,6 +70,632 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* create:
* type: array
* description: The product's create.
* items:
* type: object
* description: The create's details.
* required:
* - title
* - subtitle
* - description
* - is_giftcard
* - discountable
* - images
* - thumbnail
* - handle
* - status
* - type_id
* - collection_id
* - categories
* - tags
* - options
* - variants
* - sales_channels
* - weight
* - length
* - height
* - width
* - hs_code
* - mid_code
* - origin_country
* - material
* - metadata
* properties:
* title:
* type: string
* title: title
* description: The create's title.
* subtitle:
* type: string
* title: subtitle
* description: The create's subtitle.
* description:
* type: string
* title: description
* description: The create's description.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The create's is giftcard.
* discountable:
* type: boolean
* title: discountable
* description: The create's discountable.
* images:
* type: array
* description: The create's images.
* items:
* type: object
* description: The image's images.
* required:
* - url
* properties:
* url:
* type: string
* title: url
* description: The image's url.
* thumbnail:
* type: string
* title: thumbnail
* description: The create's thumbnail.
* handle:
* type: string
* title: handle
* description: The create's handle.
* status:
* type: string
* enum:
* - draft
* - proposed
* - published
* - rejected
* type_id:
* type: string
* title: type_id
* description: The create's type id.
* collection_id:
* type: string
* title: collection_id
* description: The create's collection id.
* categories:
* type: array
* description: The create's categories.
* items:
* type: object
* description: The category's categories.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The category's ID.
* tags:
* type: array
* description: The create's tags.
* items:
* type: object
* description: The tag's tags.
* required:
* - id
* - value
* properties:
* id:
* type: string
* title: id
* description: The tag's ID.
* value:
* type: string
* title: value
* description: The tag's value.
* options:
* type: array
* description: The create's options.
* items:
* type: object
* description: The option's options.
* required:
* - title
* - values
* properties:
* title:
* type: string
* title: title
* description: The option's title.
* values:
* type: array
* description: The option's values.
* items:
* type: string
* title: values
* description: The value's values.
* variants:
* type: array
* description: The create's variants.
* items:
* type: object
* description: The variant's variants.
* required:
* - title
* - sku
* - ean
* - upc
* - barcode
* - hs_code
* - mid_code
* - inventory_quantity
* - allow_backorder
* - manage_inventory
* - variant_rank
* - weight
* - length
* - height
* - width
* - origin_country
* - material
* - metadata
* - prices
* - options
* properties:
* title:
* type: string
* title: title
* description: The variant's title.
* sku:
* type: string
* title: sku
* description: The variant's sku.
* ean:
* type: string
* title: ean
* description: The variant's ean.
* upc:
* type: string
* title: upc
* description: The variant's upc.
* barcode:
* type: string
* title: barcode
* description: The variant's barcode.
* hs_code:
* type: string
* title: hs_code
* description: The variant's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The variant's mid code.
* inventory_quantity:
* type: number
* title: inventory_quantity
* description: The variant's inventory quantity.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The variant's allow backorder.
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The variant's manage inventory.
* variant_rank:
* type: number
* title: variant_rank
* description: The variant's variant rank.
* weight:
* type: number
* title: weight
* description: The variant's weight.
* length:
* type: number
* title: length
* description: The variant's length.
* height:
* type: number
* title: height
* description: The variant's height.
* width:
* type: number
* title: width
* description: The variant's width.
* origin_country:
* type: string
* title: origin_country
* description: The variant's origin country.
* material:
* type: string
* title: material
* description: The variant's material.
* metadata:
* type: object
* description: The variant's metadata.
* properties: {}
* prices:
* type: array
* description: The variant's prices.
* items:
* type: object
* description: The price's prices.
* properties: {}
* options:
* type: object
* description: The variant's options.
* properties: {}
* sales_channels:
* type: array
* description: The create's sales channels.
* items:
* type: object
* description: The sales channel's sales channels.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The sales channel's ID.
* weight:
* type: number
* title: weight
* description: The create's weight.
* length:
* type: number
* title: length
* description: The create's length.
* height:
* type: number
* title: height
* description: The create's height.
* width:
* type: number
* title: width
* description: The create's width.
* hs_code:
* type: string
* title: hs_code
* description: The create's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The create's mid code.
* origin_country:
* type: string
* title: origin_country
* description: The create's origin country.
* material:
* type: string
* title: material
* description: The create's material.
* metadata:
* type: object
* description: The create's metadata.
* properties: {}
* update:
* type: array
* description: The product's update.
* items:
* type: object
* description: The update's details.
* required:
* - title
* - status
* - length
* - options
* - description
* - handle
* - metadata
* - hs_code
* - weight
* - height
* - width
* - origin_country
* - mid_code
* - material
* - thumbnail
* - variants
* - collection_id
* - tags
* - type_id
* - subtitle
* - discountable
* - images
* - categories
* - sales_channels
* - id
* properties:
* title:
* type: string
* title: title
* description: The update's title.
* status:
* type: string
* enum:
* - draft
* - proposed
* - published
* - rejected
* length:
* type: number
* title: length
* description: The update's length.
* options:
* type: array
* description: The update's options.
* items:
* type: object
* description: The option's options.
* required:
* - id
* - title
* - values
* properties:
* id:
* type: string
* title: id
* description: The option's ID.
* title:
* type: string
* title: title
* description: The option's title.
* values:
* type: array
* description: The option's values.
* items:
* type: string
* title: values
* description: The value's values.
* description:
* type: string
* title: description
* description: The update's description.
* handle:
* type: string
* title: handle
* description: The update's handle.
* metadata:
* type: object
* description: The update's metadata.
* properties: {}
* hs_code:
* type: string
* title: hs_code
* description: The update's hs code.
* weight:
* type: number
* title: weight
* description: The update's weight.
* height:
* type: number
* title: height
* description: The update's height.
* width:
* type: number
* title: width
* description: The update's width.
* origin_country:
* type: string
* title: origin_country
* description: The update's origin country.
* mid_code:
* type: string
* title: mid_code
* description: The update's mid code.
* material:
* type: string
* title: material
* description: The update's material.
* thumbnail:
* type: string
* title: thumbnail
* description: The update's thumbnail.
* variants:
* type: array
* description: The update's variants.
* items:
* type: object
* description: The variant's variants.
* required:
* - length
* - options
* - metadata
* - sku
* - barcode
* - hs_code
* - weight
* - height
* - width
* - origin_country
* - mid_code
* - material
* - ean
* - upc
* - variant_rank
* - id
* - title
* - prices
* - inventory_quantity
* - allow_backorder
* - manage_inventory
* properties:
* length:
* type: number
* title: length
* description: The variant's length.
* options:
* type: object
* description: The variant's options.
* properties: {}
* metadata:
* type: object
* description: The variant's metadata.
* properties: {}
* sku:
* type: string
* title: sku
* description: The variant's sku.
* barcode:
* type: string
* title: barcode
* description: The variant's barcode.
* hs_code:
* type: string
* title: hs_code
* description: The variant's hs code.
* weight:
* type: number
* title: weight
* description: The variant's weight.
* height:
* type: number
* title: height
* description: The variant's height.
* width:
* type: number
* title: width
* description: The variant's width.
* origin_country:
* type: string
* title: origin_country
* description: The variant's origin country.
* mid_code:
* type: string
* title: mid_code
* description: The variant's mid code.
* material:
* type: string
* title: material
* description: The variant's material.
* ean:
* type: string
* title: ean
* description: The variant's ean.
* upc:
* type: string
* title: upc
* description: The variant's upc.
* variant_rank:
* type: number
* title: variant_rank
* description: The variant's variant rank.
* id:
* type: string
* title: id
* description: The variant's ID.
* title:
* type: string
* title: title
* description: The variant's title.
* prices:
* type: array
* description: The variant's prices.
* items:
* type: object
* description: The price's prices.
* properties: {}
* inventory_quantity:
* type: number
* title: inventory_quantity
* description: The variant's inventory quantity.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The variant's allow backorder.
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The variant's manage inventory.
* collection_id:
* type: string
* title: collection_id
* description: The update's collection id.
* tags:
* type: array
* description: The update's tags.
* items:
* type: object
* description: The tag's tags.
* required:
* - id
* - value
* properties:
* id:
* type: string
* title: id
* description: The tag's ID.
* value:
* type: string
* title: value
* description: The tag's value.
* type_id:
* type: string
* title: type_id
* description: The update's type id.
* subtitle:
* type: string
* title: subtitle
* description: The update's subtitle.
* discountable:
* type: boolean
* title: discountable
* description: The update's discountable.
* images:
* type: array
* description: The update's images.
* items:
* type: object
* description: The image's images.
* required:
* - url
* properties:
* url:
* type: string
* title: url
* description: The image's url.
* categories:
* type: array
* description: The update's categories.
* items:
* type: object
* description: The category's categories.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The category's ID.
* sales_channels:
* type: array
* description: The update's sales channels.
* items:
* type: object
* description: The sales channel's sales channels.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The sales channel's ID.
* id:
* type: string
* title: id
* description: The update's ID.
* delete:
* type: array
* description: The product's delete.
* items:
* type: string
* title: delete
* description: The delete's details.
*
*/

View File

@@ -53,38 +53,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreatePromotion"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/promotions' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "code": "{value}",
* "type": "{value}"
* }'
* tags:
* - Promotions
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - code
* - is_automatic
@@ -102,7 +72,11 @@
* type: boolean
* title: is_automatic
* description: The promotion's is automatic.
* type: {}
* type:
* type: string
* enum:
* - standard
* - buyget
* campaign_id:
* type: string
* title: campaign_id
@@ -143,7 +117,11 @@
* - type
* - limit
* properties:
* type: {}
* type:
* type: string
* enum:
* - spend
* - usage
* limit:
* type: number
* title: limit
@@ -198,9 +176,22 @@
* type: number
* title: max_quantity
* description: The application method's max quantity.
* type: {}
* target_type: {}
* allocation: {}
* type:
* type: string
* enum:
* - fixed
* - percentage
* target_type:
* type: string
* enum:
* - order
* - shipping_methods
* - items
* allocation:
* type: string
* enum:
* - each
* - across
* target_rules:
* type: array
* description: The application method's target rules.
@@ -213,7 +204,16 @@
* - attribute
* - values
* properties:
* operator: {}
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
@@ -241,7 +241,16 @@
* - attribute
* - values
* properties:
* operator: {}
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
@@ -277,7 +286,16 @@
* - attribute
* - values
* properties:
* operator: {}
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
@@ -293,6 +311,69 @@
* type: string
* title: values
* description: The value's values.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/promotions' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "code": "{value}",
* "is_automatic": false,
* "type": "{value}",
* "campaign_id": "{value}",
* "campaign": {
* "name": "Helene",
* "campaign_identifier": "{value}",
* "description": "{value}",
* "currency": "MVR",
* "budget": {
* "type": "{value}",
* "limit": 7501249997963264
* },
* "starts_at": "2024-08-12T10:26:20.012Z",
* "ends_at": "2024-05-13T10:19:49.899Z",
* "promotions": []
* },
* "application_method": {
* "description": "{value}",
* "value": 8358287623847936,
* "max_quantity": 2469068038733824,
* "type": "{value}",
* "target_type": "{value}",
* "allocation": "{value}",
* "target_rules": [],
* "buy_rules": [],
* "apply_to_quantity": 5904452787634176,
* "buy_rules_min_quantity": 7660936294825984
* },
* "rules": [
* {
* "operator": "{value}",
* "description": "{value}",
* "attribute": "{value}",
* "values": [
* "{value}"
* ]
* }
* ]
* }'
* tags:
* - Promotions
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -74,6 +74,7 @@
* enum:
* - standard
* - buyget
* type: string
* campaign_id:
* type: string
* title: campaign_id
@@ -115,6 +116,7 @@
* enum:
* - spend
* - usage
* type: string
* limit:
* type: number
* title: limit
@@ -163,15 +165,18 @@
* enum:
* - fixed
* - percentage
* type: string
* target_type:
* enum:
* - order
* - shipping_methods
* - items
* type: string
* allocation:
* enum:
* - each
* - across
* type: string
* target_rules:
* type: array
* description: The application method's target rules.
@@ -193,6 +198,7 @@
* - eq
* - ne
* - in
* type: string
* description:
* type: string
* title: description
@@ -229,6 +235,7 @@
* - eq
* - ne
* - in
* type: string
* description:
* type: string
* title: description
@@ -284,6 +291,7 @@
* - eq
* - ne
* - in
* type: string
* description:
* type: string
* title: description

View File

@@ -64,8 +64,6 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -78,6 +76,99 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* create:
* type: array
* description: The promotion's create.
* items:
* type: object
* description: The create's details.
* required:
* - operator
* - description
* - attribute
* - values
* properties:
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
* description: The create's description.
* attribute:
* type: string
* title: attribute
* description: The create's attribute.
* values:
* type: array
* description: The create's values.
* items:
* type: string
* title: values
* description: The value's values.
* update:
* type: array
* description: The promotion's update.
* items:
* type: object
* description: The update's details.
* required:
* - id
* - operator
* - description
* - attribute
* - values
* properties:
* id:
* type: string
* title: id
* description: The update's ID.
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
* description: The update's description.
* attribute:
* type: string
* title: attribute
* description: The update's attribute.
* values:
* type: array
* description: The update's values.
* items:
* type: string
* title: values
* description: The value's values.
* delete:
* type: array
* description: The promotion's delete.
* items:
* type: string
* title: delete
* description: The delete's details.
*
*/

View File

@@ -64,8 +64,6 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -78,6 +76,99 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* create:
* type: array
* description: The promotion's create.
* items:
* type: object
* description: The create's details.
* required:
* - operator
* - description
* - attribute
* - values
* properties:
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
* description: The create's description.
* attribute:
* type: string
* title: attribute
* description: The create's attribute.
* values:
* type: array
* description: The create's values.
* items:
* type: string
* title: values
* description: The value's values.
* update:
* type: array
* description: The promotion's update.
* items:
* type: object
* description: The update's details.
* required:
* - id
* - operator
* - description
* - attribute
* - values
* properties:
* id:
* type: string
* title: id
* description: The update's ID.
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
* description: The update's description.
* attribute:
* type: string
* title: attribute
* description: The update's attribute.
* values:
* type: array
* description: The update's values.
* items:
* type: string
* title: values
* description: The value's values.
* delete:
* type: array
* description: The promotion's delete.
* items:
* type: string
* title: delete
* description: The delete's details.
*
*/

View File

@@ -64,8 +64,6 @@
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -78,6 +76,99 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* create:
* type: array
* description: The promotion's create.
* items:
* type: object
* description: The create's details.
* required:
* - operator
* - description
* - attribute
* - values
* properties:
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
* description: The create's description.
* attribute:
* type: string
* title: attribute
* description: The create's attribute.
* values:
* type: array
* description: The create's values.
* items:
* type: string
* title: values
* description: The value's values.
* update:
* type: array
* description: The promotion's update.
* items:
* type: object
* description: The update's details.
* required:
* - id
* - operator
* - description
* - attribute
* - values
* properties:
* id:
* type: string
* title: id
* description: The update's ID.
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
* description: The update's description.
* attribute:
* type: string
* title: attribute
* description: The update's attribute.
* values:
* type: array
* description: The update's values.
* items:
* type: string
* title: values
* description: The value's values.
* delete:
* type: array
* description: The promotion's delete.
* items:
* type: string
* title: delete
* description: The delete's details.
*
*/

View File

@@ -53,38 +53,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateRegion"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/regions' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "name": "Giovanna",
* "currency_code": "{value}"
* }'
* tags:
* - Regions
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - name
* - currency_code
@@ -123,6 +93,40 @@
* type: object
* description: The region's metadata.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/regions' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "name": "Charlie",
* "currency_code": "{value}",
* "countries": [
* "{value}"
* ],
* "automatic_taxes": true,
* "payment_providers": [
* "{value}"
* ],
* "metadata": {}
* }'
* tags:
* - Regions
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -59,33 +59,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/UpdateRegion"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/regions/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Regions
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - name
* - currency_code
@@ -124,6 +99,40 @@
* type: object
* description: The region's metadata.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/regions/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "name": "Alden",
* "currency_code": "{value}",
* "countries": [
* "{value}"
* ],
* "automatic_taxes": false,
* "payment_providers": [
* "{value}"
* ],
* "metadata": {}
* }'
* tags:
* - Regions
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/

View File

@@ -4,7 +4,47 @@
* summary: Create Reservation
* description: Create a reservation.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -65,8 +105,6 @@
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -59,8 +99,6 @@
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -45,8 +85,6 @@
* tags:
* - Sales Channels
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -4,7 +4,47 @@
* summary: Create Shipping Option
* description: Create a shipping option.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -42,7 +82,8 @@
* type: object
* description: The shipping option's data.
* properties: {}
* price_type: {}
* price_type:
* type: string
* provider_id:
* type: string
* title: provider_id
@@ -111,7 +152,8 @@
* - attribute
* - value
* properties:
* operator: {}
* operator:
* type: string
* attribute:
* type: string
* title: attribute
@@ -157,6 +199,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminShippingOptionRetrieveResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -26,6 +66,7 @@
* - data
* - price_type
* - provider_id
* - shipping_profile_id
* - type
* - prices
* - rules
@@ -38,7 +79,8 @@
* type: object
* description: The shipping option's data.
* properties: {}
* price_type: {}
* price_type:
* type: string
* provider_id:
* type: string
* title: provider_id
@@ -162,6 +204,10 @@
* type: string
* title: value
* description: The value's details.
* shipping_profile_id:
* type: string
* title: shipping_profile_id
* description: The shipping option's shipping profile id.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -186,6 +232,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminShippingOptionRetrieveResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -24,8 +64,6 @@
* tags:
* - Shipping Options
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -38,6 +76,99 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* create:
* type: array
* description: The shipping option's create.
* items:
* type: object
* description: The create's details.
* required:
* - operator
* - attribute
* - value
* properties:
* operator:
* type: string
* enum:
* - in
* - eq
* - ne
* - gt
* - gte
* - lt
* - lte
* - nin
* attribute:
* type: string
* title: attribute
* description: The create's attribute.
* value:
* oneOf:
* - type: string
* title: value
* description: The create's value.
* - type: array
* description: The create's value.
* items:
* type: string
* title: value
* description: The value's details.
* update:
* type: array
* description: The shipping option's update.
* items:
* type: object
* description: The update's details.
* required:
* - id
* - operator
* - attribute
* - value
* properties:
* id:
* type: string
* title: id
* description: The update's ID.
* operator:
* type: string
* enum:
* - in
* - eq
* - ne
* - gt
* - gte
* - lt
* - lte
* - nin
* attribute:
* type: string
* title: attribute
* description: The update's attribute.
* value:
* oneOf:
* - type: string
* title: value
* description: The update's value.
* - type: array
* description: The update's value.
* items:
* type: string
* title: value
* description: The value's details.
* delete:
* type: array
* description: The shipping option's delete.
* items:
* type: string
* title: delete
* description: The delete's details.
*
*/

View File

@@ -4,7 +4,47 @@
* summary: Create Shipping Profile
* description: Create a shipping profile.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -49,6 +89,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminShippingProfileResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -4,7 +4,47 @@
* summary: Create Stock Location
* description: Create a stock location.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -109,8 +149,6 @@
* tags:
* - Stock Locations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -47,8 +87,6 @@
* tags:
* - Stock Locations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -11,6 +11,46 @@
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -45,8 +85,6 @@
* tags:
* - Stock Locations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":

View File

@@ -4,7 +4,47 @@
* summary: Create Upload
* description: Create a upload.
* x-authenticated: true
* parameters: []
* 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.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - 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: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* security:
* - api_token: []
* - cookie_auth: []
@@ -18,8 +58,6 @@
* tags:
* - Uploads
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -32,6 +70,11 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateProduct"
*
*/

View File

@@ -62,7 +62,7 @@
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "email": "Luz20@gmail.com"
* "email": "Moises11@hotmail.com"
* }'
* tags:
* - Users
@@ -79,10 +79,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