Files
medusa-store/docs/api/admin/paths/shipping-profiles.yaml
2023-01-19 10:06:17 +02:00

82 lines
2.2 KiB
YAML

post:
operationId: PostShippingProfiles
summary: Create a Shipping Profile
description: Creates a Shipping Profile
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostShippingProfilesReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/shipping-profiles/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/shipping-profiles/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Shipping Profile
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
get:
operationId: GetShippingProfiles
summary: List Shipping Profiles
description: Retrieves a list of Shipping Profile.
x-authenticated: true
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/shipping-profiles/getundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/shipping-profiles/getundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Shipping Profile
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