Files
medusa-store/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml
2023-02-09 09:50:55 +02:00

147 lines
3.9 KiB
YAML

post:
operationId: PostTaxRatesTaxRateShippingOptions
summary: Add to Shipping Options
description: Associates a Tax Rate with a list of Shipping Options
parameters:
- in: path
name: id
required: true
description: ID of the tax rate.
schema:
type: string
- in: query
name: fields
description: Which fields should be included in the result.
style: form
explode: false
schema:
type: array
items:
type: string
- in: query
name: expand
description: Which fields should be expanded and retrieved in the result.
style: form
explode: false
schema:
type: array
items:
type: string
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: >-
../components/schemas/AdminPostTaxRatesTaxRateShippingOptionsReq.yaml
x-codegen:
method: addShippingOptions
queryParams: AdminPostTaxRatesTaxRateShippingOptionsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/tax-rates_{id}_shipping-options_batch/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/tax-rates_{id}_shipping-options_batch/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Tax Rate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminTaxRatesRes.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
delete:
operationId: DeleteTaxRatesTaxRateShippingOptions
summary: Del. for Shipping Options
description: Removes a Tax Rate from a list of Shipping Options
parameters:
- in: path
name: id
required: true
description: ID of the tax rate.
schema:
type: string
- in: query
name: fields
description: Which fields should be included in the result.
style: form
explode: false
schema:
type: array
items:
type: string
- in: query
name: expand
description: Which fields should be expanded and retrieved in the result.
style: form
explode: false
schema:
type: array
items:
type: string
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: >-
../components/schemas/AdminDeleteTaxRatesTaxRateShippingOptionsReq.yaml
x-codegen:
method: removeShippingOptions
queryParams: AdminDeleteTaxRatesTaxRateShippingOptionsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/tax-rates_{id}_shipping-options_batch/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/tax-rates_{id}_shipping-options_batch/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Tax Rate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminTaxRatesRes.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