54 lines
1.5 KiB
YAML
54 lines
1.5 KiB
YAML
get:
|
|
operationId: GetShippingOptions
|
|
summary: Get Shipping Options
|
|
description: Retrieves a list of Shipping Options.
|
|
parameters:
|
|
- in: query
|
|
name: is_return
|
|
description: >-
|
|
Whether return Shipping Options should be included. By default all
|
|
Shipping Options are returned.
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: product_ids
|
|
description: A comma separated list of Product ids to filter Shipping Options by.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: region_id
|
|
description: the Region to retrieve Shipping Options from.
|
|
schema:
|
|
type: string
|
|
x-codegen:
|
|
method: list
|
|
queryParams: StoreGetShippingOptionsParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/shipping-options/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/shipping-options/get.sh
|
|
tags:
|
|
- Shipping Option
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/StoreShippingOptionsListRes.yaml
|
|
'400':
|
|
$ref: ../components/responses/400_error.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
|