658339767b
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
59 lines
1.7 KiB
YAML
59 lines
1.7 KiB
YAML
get:
|
|
operationId: GetShippingOptions
|
|
summary: Get Shipping Options
|
|
description: Retrieve 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: >-
|
|
"Comma-separated list of Product IDs to filter Shipping Options by. If
|
|
provided, only shipping options that can be used with the provided
|
|
products are retrieved."
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: region_id
|
|
description: >-
|
|
"The ID of the region that the shipping options belong to. If not
|
|
provided, all shipping options are retrieved."
|
|
schema:
|
|
type: string
|
|
x-codegen:
|
|
method: list
|
|
queryParams: StoreGetShippingOptionsParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/store_shipping-options/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/store_shipping-options/get.sh
|
|
tags:
|
|
- Shipping Options
|
|
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
|