Files
medusa-store/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml
2023-09-29 23:46:58 +03:00

88 lines
2.3 KiB
YAML

get:
operationId: GetShippingProfiles
summary: List Shipping Profiles
description: Retrieve a list of Shipping Profiles.
x-authenticated: true
x-codegen:
method: list
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_shipping-profiles/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_shipping-profiles/get.sh
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
tags:
- Shipping Profiles
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminShippingProfilesListRes.yaml
'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: PostShippingProfiles
summary: Create a Shipping Profile
description: Create a Shipping Profile.
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostShippingProfilesReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_shipping-profiles/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_shipping-profiles/post.sh
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
tags:
- Shipping Profiles
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminShippingProfilesRes.yaml
'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