chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
committed by
GitHub
parent
efdea04963
commit
658339767b
@@ -1,24 +1,26 @@
|
||||
get:
|
||||
operationId: GetShippingOptions
|
||||
summary: List Shipping Options
|
||||
description: Retrieves a list of Shipping Options.
|
||||
description: >-
|
||||
Retrieve a list of Shipping Options. The shipping options can be filtered by
|
||||
fields such as `region_id` or `is_return`.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: query
|
||||
name: region_id
|
||||
schema:
|
||||
type: string
|
||||
description: Region ID to fetch options from
|
||||
description: Filter by a region ID.
|
||||
- in: query
|
||||
name: is_return
|
||||
description: Filter by whether the shipping option is used for returns or orders.
|
||||
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
|
||||
description: Filter by whether the shipping option is used only by admins or not.
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetShippingOptionsParams
|
||||
@@ -58,7 +60,7 @@ get:
|
||||
post:
|
||||
operationId: PostShippingOptions
|
||||
summary: Create Shipping Option
|
||||
description: Creates a Shipping Option
|
||||
description: Create a Shipping Option.
|
||||
x-authenticated: true
|
||||
requestBody:
|
||||
content:
|
||||
|
||||
Reference in New Issue
Block a user