109 lines
2.9 KiB
YAML
109 lines
2.9 KiB
YAML
post:
|
|
operationId: PostShippingOptions
|
|
summary: Create Shipping Option
|
|
description: Creates a Shipping Option
|
|
x-authenticated: true
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminPostShippingOptionsReq.yaml
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/shipping-options/postundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/shipping-options/postundefined
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Shipping Option
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
shipping_option:
|
|
$ref: ../components/schemas/ShippingOption.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: GetShippingOptions
|
|
summary: List Shipping Options
|
|
description: Retrieves a list of Shipping Options.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: query
|
|
name: region_id
|
|
schema:
|
|
type: string
|
|
description: Region ID to fetch options from
|
|
- in: query
|
|
name: is_return
|
|
schema:
|
|
type: boolean
|
|
description: Flag for fetching return options only
|
|
- in: query
|
|
name: admin_only
|
|
schema:
|
|
type: boolean
|
|
description: Flag for fetching admin specific options
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/shipping-options/getundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/shipping-options/getundefined
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Shipping Option
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
shipping_options:
|
|
type: array
|
|
items:
|
|
$ref: ../components/schemas/ShippingOption.yaml
|
|
count:
|
|
type: integer
|
|
description: The total number of items available
|
|
'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
|