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

chore(docs): Generated API Reference (v2) (#8318)

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-07-29 09:41:02 +02:00
committed by GitHub
parent 56f634da4b
commit e40b4c6183
134 changed files with 7310 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
www/apps/api-reference/specs/admin/paths/admin_claims.yaml Normal file
View File

@@ -0,0 +1,177 @@
get:
operationId: GetClaims
summary: List Claims
description: >-
Retrieve a list of claims. The claims can be filtered by fields such as
`id`. The claims can also be sorted or paginated.
x-authenticated: true
parameters:
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_claims/get.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostClaims
summary: Create Claim
description: Create a claim.
x-authenticated: true
parameters:
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostOrderClaimsReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_claims/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

96
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml Normal file
View File

@@ -0,0 +1,96 @@
post:
operationId: PostClaimsIdClaimItems
summary: Add Claim Items to Claim
description: Add a list of claim items to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostClaimItemsReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_claims_{id}_claim-items/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

203
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml Normal file
View File

@@ -0,0 +1,203 @@
post:
operationId: PostClaimsIdClaimItemsAction_id
summary: Add Claim Items to Claim
description: Add a list of claim items to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: action_id
in: path
description: The claim's action id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteClaimsIdClaimItemsAction_id
summary: Remove Claim Items from Claim
description: >-
Remove a list of claim items from a claim. This doesn't delete the Claim
Item, only the association between the Claim Item and the claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: action_id
in: path
description: The claim's action id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_claim-items_{action_id}/delete.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

96
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml Normal file
View File

@@ -0,0 +1,96 @@
post:
operationId: PostClaimsIdInboundItems
summary: Add Items to Claim
description: Add a list of items to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_claims_{id}_inbound_items/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

204
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml Normal file
View File

@@ -0,0 +1,204 @@
post:
operationId: PostClaimsIdInboundItemsAction_id
summary: Add Items to Claim
description: Add a list of items to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: action_id
in: path
description: The claim's action id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: >-
../components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteClaimsIdInboundItemsAction_id
summary: Remove Items from Claim
description: >-
Remove a list of items from a claim. This doesn't delete the Item, only the
association between the Item and the claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: action_id
in: path
description: The claim's action id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

97
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml Normal file
View File

@@ -0,0 +1,97 @@
post:
operationId: PostClaimsIdInboundShippingMethod
summary: Add Shipping Methods to Claim
description: Add a list of shipping methods to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostReturnsShippingReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_inbound_shipping-method/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

204
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml Normal file
View File

@@ -0,0 +1,204 @@
post:
operationId: PostClaimsIdInboundShippingMethodAction_id
summary: Add Shipping Methods to Claim
description: Add a list of shipping methods to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: action_id
in: path
description: The claim's action id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteClaimsIdInboundShippingMethodAction_id
summary: Remove Shipping Methods from Claim
description: >-
Remove a list of shipping methods from a claim. This doesn't delete the
Shipping Method, only the association between the Shipping Method and the
claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: action_id
in: path
description: The claim's action id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

96
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml Normal file
View File

@@ -0,0 +1,96 @@
post:
operationId: PostClaimsIdOutboundItems
summary: Add Items to Claim
description: Add a list of items to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostClaimsAddItemsReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_claims_{id}_outbound_items/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

203
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml Normal file
View File

@@ -0,0 +1,203 @@
post:
operationId: PostClaimsIdOutboundItemsAction_id
summary: Add Items to Claim
description: Add a list of items to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: action_id
in: path
description: The claim's action id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteClaimsIdOutboundItemsAction_id
summary: Remove Items from Claim
description: >-
Remove a list of items from a claim. This doesn't delete the Item, only the
association between the Item and the claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: action_id
in: path
description: The claim's action id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

97
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml Normal file
View File

@@ -0,0 +1,97 @@
post:
operationId: PostClaimsIdOutboundShippingMethod
summary: Add Shipping Methods to Claim
description: Add a list of shipping methods to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostClaimsShippingReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_outbound_shipping-method/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

204
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml Normal file
View File

@@ -0,0 +1,204 @@
post:
operationId: PostClaimsIdOutboundShippingMethodAction_id
summary: Add Shipping Methods to Claim
description: Add a list of shipping methods to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: action_id
in: path
description: The claim's action id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteClaimsIdOutboundShippingMethodAction_id
summary: Remove Shipping Methods from Claim
description: >-
Remove a list of shipping methods from a claim. This doesn't delete the
Shipping Method, only the association between the Shipping Method and the
claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: action_id
in: path
description: The claim's action id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

4
www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml
View File

@@ -166,7 +166,6 @@ get:
description: The inventory item's weight.
required: false
schema:
type: object
description: The inventory item's weight.
required:
- $eq
@@ -199,7 +198,6 @@ get:
description: The inventory item's length.
required: false
schema:
type: object
description: The inventory item's length.
required:
- $eq
@@ -232,7 +230,6 @@ get:
description: The inventory item's height.
required: false
schema:
type: object
description: The inventory item's height.
required:
- $eq
@@ -265,7 +262,6 @@ get:
description: The inventory item's width.
required: false
schema:
type: object
description: The inventory item's width.
required:
- $eq

9
www/apps/api-reference/specs/admin/paths/admin_invites.yaml
View File

@@ -104,7 +104,7 @@ get:
description: The invite's created at.
required: false
schema:
type: object
type: string
description: The invite's created at.
required:
- $eq
@@ -132,12 +132,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The invite's updated at.
required: false
schema:
type: object
type: string
description: The invite's updated at.
required:
- $eq
@@ -165,12 +166,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The invite's deleted at.
required: false
schema:
type: object
type: string
description: The invite's deleted at.
required:
- $eq
@@ -198,6 +200,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false

9
www/apps/api-reference/specs/admin/paths/admin_payments.yaml
View File

@@ -102,7 +102,7 @@ get:
description: The payment's created at.
required: false
schema:
type: object
type: string
description: The payment's created at.
required:
- $eq
@@ -130,12 +130,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The payment's updated at.
required: false
schema:
type: object
type: string
description: The payment's updated at.
required:
- $eq
@@ -163,12 +164,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The payment's deleted at.
required: false
schema:
type: object
type: string
description: The payment's deleted at.
required:
- $eq
@@ -196,6 +198,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false

9
www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml
View File

@@ -163,7 +163,7 @@ get:
description: The product category's created at.
required: false
schema:
type: object
type: string
description: The product category's created at.
required:
- $eq
@@ -191,12 +191,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The product category's updated at.
required: false
schema:
type: object
type: string
description: The product category's updated at.
required:
- $eq
@@ -224,12 +225,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The product category's deleted at.
required: false
schema:
type: object
type: string
description: The product category's deleted at.
required:
- $eq
@@ -257,6 +259,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false

9
www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml
View File

@@ -102,7 +102,7 @@ get:
description: The product tag's created at.
required: false
schema:
type: object
type: string
description: The product tag's created at.
required:
- $eq
@@ -130,12 +130,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The product tag's updated at.
required: false
schema:
type: object
type: string
description: The product tag's updated at.
required:
- $eq
@@ -163,12 +164,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The product tag's deleted at.
required: false
schema:
type: object
type: string
description: The product tag's deleted at.
required:
- $eq
@@ -196,6 +198,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false

9
www/apps/api-reference/specs/admin/paths/admin_product-types.yaml
View File

@@ -102,7 +102,7 @@ get:
description: The product type's created at.
required: false
schema:
type: object
type: string
description: The product type's created at.
required:
- $eq
@@ -130,12 +130,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The product type's updated at.
required: false
schema:
type: object
type: string
description: The product type's updated at.
required:
- $eq
@@ -163,12 +164,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The product type's deleted at.
required: false
schema:
type: object
type: string
description: The product type's deleted at.
required:
- $eq
@@ -196,6 +198,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false

92
www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml Normal file
View File

@@ -0,0 +1,92 @@
post:
operationId: PostProductsImportTransaction_idConfirm
summary: Add Confirms to Product
description: Add a list of confirms to a product.
x-authenticated: true
parameters:
- name: transaction_id
in: path
description: The product's transaction id.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_products_import_{transaction_id}_confirm/post.sh
tags:
- Products
responses:
'202':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

9
www/apps/api-reference/specs/admin/paths/admin_promotions.yaml
View File

@@ -121,7 +121,7 @@ get:
description: The promotion's created at.
required: false
schema:
type: object
type: string
description: The promotion's created at.
required:
- $eq
@@ -149,12 +149,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The promotion's updated at.
required: false
schema:
type: object
type: string
description: The promotion's updated at.
required:
- $eq
@@ -182,12 +183,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The promotion's deleted at.
required: false
schema:
type: object
type: string
description: The promotion's deleted at.
required:
- $eq
@@ -215,6 +217,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false

9
www/apps/api-reference/specs/admin/paths/admin_regions.yaml
View File

@@ -116,7 +116,7 @@ get:
description: The region's created at.
required: false
schema:
type: object
type: string
description: The region's created at.
required:
- $eq
@@ -144,12 +144,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The region's updated at.
required: false
schema:
type: object
type: string
description: The region's updated at.
required:
- $eq
@@ -177,12 +178,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The region's deleted at.
required: false
schema:
type: object
type: string
description: The region's deleted at.
required:
- $eq
@@ -210,6 +212,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false

10
www/apps/api-reference/specs/admin/paths/admin_reservations.yaml
View File

@@ -158,7 +158,6 @@ get:
description: The reservation's quantity.
required: false
schema:
type: object
description: The reservation's quantity.
required:
- $eq
@@ -191,7 +190,7 @@ get:
description: The reservation's created at.
required: false
schema:
type: object
type: string
description: The reservation's created at.
required:
- $eq
@@ -219,12 +218,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The reservation's updated at.
required: false
schema:
type: object
type: string
description: The reservation's updated at.
required:
- $eq
@@ -252,12 +252,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The reservation's deleted at.
required: false
schema:
type: object
type: string
description: The reservation's deleted at.
required:
- $eq
@@ -285,6 +286,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
security:
- api_token: []
- cookie_auth: []

96
www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml
View File

@@ -91,3 +91,99 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostReturnsId
summary: Update a Return
description: Update a return's details.
x-authenticated: true
parameters:
- name: id
in: path
description: The return's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostReturnsReturnReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_returns_{id}/post.sh
tags:
- Returns
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

9
www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml
View File

@@ -118,7 +118,7 @@ get:
description: The sales channel's created at.
required: false
schema:
type: object
type: string
description: The sales channel's created at.
required:
- $eq
@@ -146,12 +146,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The sales channel's updated at.
required: false
schema:
type: object
type: string
description: The sales channel's updated at.
required:
- $eq
@@ -179,12 +180,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The sales channel's deleted at.
required: false
schema:
type: object
type: string
description: The sales channel's deleted at.
required:
- $eq
@@ -212,6 +214,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: location_id
in: query
required: false

9
www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml
View File

@@ -144,7 +144,7 @@ get:
description: The shipping option's created at.
required: false
schema:
type: object
type: string
description: The shipping option's created at.
required:
- $eq
@@ -172,12 +172,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The shipping option's updated at.
required: false
schema:
type: object
type: string
description: The shipping option's updated at.
required:
- $eq
@@ -205,12 +206,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The shipping option's deleted at.
required: false
schema:
type: object
type: string
description: The shipping option's deleted at.
required:
- $eq
@@ -238,6 +240,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
security:
- api_token: []
- cookie_auth: []

9
www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml
View File

@@ -105,7 +105,7 @@ get:
description: The shipping profile's created at.
required: false
schema:
type: object
type: string
description: The shipping profile's created at.
required:
- $eq
@@ -133,12 +133,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The shipping profile's updated at.
required: false
schema:
type: object
type: string
description: The shipping profile's updated at.
required:
- $eq
@@ -166,12 +167,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The shipping profile's deleted at.
required: false
schema:
type: object
type: string
description: The shipping profile's deleted at.
required:
- $eq
@@ -199,6 +201,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false

9
www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml
View File

@@ -130,7 +130,7 @@ get:
description: The stock location's created at.
required: false
schema:
type: object
type: string
description: The stock location's created at.
required:
- $eq
@@ -158,12 +158,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The stock location's updated at.
required: false
schema:
type: object
type: string
description: The stock location's updated at.
required:
- $eq
@@ -191,12 +192,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The stock location's deleted at.
required: false
schema:
type: object
type: string
description: The stock location's deleted at.
required:
- $eq
@@ -224,6 +226,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false

113
www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml Normal file
View File

@@ -0,0 +1,113 @@
post:
operationId: PostStockLocationsIdFulfillmentProviders
summary: Add Fulfillment Providers to Stock Location
description: Add a list of fulfillment providers to a stock location.
x-authenticated: true
parameters:
- name: id
in: path
description: The stock location's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
required: false
schema:
type: string
title: fields
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
type: object
description: SUMMARY
properties:
add:
type: array
description: The stock location's add.
items:
type: string
title: add
description: The add's details.
remove:
type: array
description: The stock location's remove.
items:
type: string
title: remove
description: The remove's details.
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_stock-locations_{id}_fulfillment-providers/post.sh
tags:
- Stock Locations
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

9
www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml
View File

@@ -124,7 +124,7 @@ get:
description: The tax rate's created at.
required: false
schema:
type: object
type: string
description: The tax rate's created at.
required:
- $eq
@@ -152,12 +152,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The tax rate's updated at.
required: false
schema:
type: object
type: string
description: The tax rate's updated at.
required:
- $eq
@@ -185,12 +186,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The tax rate's deleted at.
required: false
schema:
type: object
type: string
description: The tax rate's deleted at.
required:
- $eq
@@ -218,6 +220,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false

9
www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml
View File

@@ -228,7 +228,7 @@ get:
description: The tax region's created at.
required: false
schema:
type: object
type: string
description: The tax region's created at.
required:
- $eq
@@ -256,12 +256,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: created_at
- name: updated_at
in: query
description: The tax region's updated at.
required: false
schema:
type: object
type: string
description: The tax region's updated at.
required:
- $eq
@@ -289,12 +290,13 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: updated_at
- name: deleted_at
in: query
description: The tax region's deleted at.
required: false
schema:
type: object
type: string
description: The tax region's deleted at.
required:
- $eq
@@ -322,6 +324,7 @@ get:
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
- name: $and
in: query
required: false