chore(docs): Updated API Reference (#6220)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
21c1c5ce6c
commit
bbf79169a9
@@ -3,24 +3,147 @@ get:
|
||||
summary: List Shipping Options
|
||||
description: >-
|
||||
Retrieve a list of Shipping Options. The shipping options can be filtered by
|
||||
fields such as `region_id` or `is_return`.
|
||||
fields such as `region_id` or `is_return`. The shipping options can also be
|
||||
sorted or paginated.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: query
|
||||
name: region_id
|
||||
name: name
|
||||
description: Filter by name.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: region_id
|
||||
description: Filter by the ID of the region the shipping options belong to.
|
||||
schema:
|
||||
type: string
|
||||
description: Filter by a region ID.
|
||||
- in: query
|
||||
name: is_return
|
||||
description: Filter by whether the shipping option is used for returns or orders.
|
||||
description: Filter by whether the shipping options are return shipping options.
|
||||
schema:
|
||||
type: boolean
|
||||
- in: query
|
||||
name: admin_only
|
||||
description: >-
|
||||
Filter by whether the shipping options are available for admin users
|
||||
only.
|
||||
schema:
|
||||
type: boolean
|
||||
description: Filter by whether the shipping option is used only by admins or not.
|
||||
- in: query
|
||||
name: q
|
||||
description: Term used to search shipping options' name.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: order
|
||||
description: A shipping option field to sort-order the retrieved shipping options by.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: id
|
||||
style: form
|
||||
explode: false
|
||||
description: Filter by shipping option IDs.
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
description: ID of the shipping option.
|
||||
- type: array
|
||||
items:
|
||||
type: string
|
||||
description: ID of a shipping option.
|
||||
- in: query
|
||||
name: created_at
|
||||
description: Filter by a creation date range.
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
lt:
|
||||
type: string
|
||||
description: filter by dates less than this date
|
||||
format: date
|
||||
gt:
|
||||
type: string
|
||||
description: filter by dates greater than this date
|
||||
format: date
|
||||
lte:
|
||||
type: string
|
||||
description: filter by dates less than or equal to this date
|
||||
format: date
|
||||
gte:
|
||||
type: string
|
||||
description: filter by dates greater than or equal to this date
|
||||
format: date
|
||||
- in: query
|
||||
name: updated_at
|
||||
description: Filter by an update date range.
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
lt:
|
||||
type: string
|
||||
description: filter by dates less than this date
|
||||
format: date
|
||||
gt:
|
||||
type: string
|
||||
description: filter by dates greater than this date
|
||||
format: date
|
||||
lte:
|
||||
type: string
|
||||
description: filter by dates less than or equal to this date
|
||||
format: date
|
||||
gte:
|
||||
type: string
|
||||
description: filter by dates greater than or equal to this date
|
||||
format: date
|
||||
- in: query
|
||||
name: deleted_at
|
||||
description: Filter by a deletion date range.
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
lt:
|
||||
type: string
|
||||
description: filter by dates less than this date
|
||||
format: date
|
||||
gt:
|
||||
type: string
|
||||
description: filter by dates greater than this date
|
||||
format: date
|
||||
lte:
|
||||
type: string
|
||||
description: filter by dates less than or equal to this date
|
||||
format: date
|
||||
gte:
|
||||
type: string
|
||||
description: filter by dates greater than or equal to this date
|
||||
format: date
|
||||
- in: query
|
||||
name: offset
|
||||
description: The number of users to skip when retrieving the shipping options.
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
- in: query
|
||||
name: limit
|
||||
description: Limit the number of shipping options returned.
|
||||
schema:
|
||||
type: integer
|
||||
default: 20
|
||||
- in: query
|
||||
name: expand
|
||||
description: >-
|
||||
Comma-separated relations that should be expanded in the returned
|
||||
shipping options.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned shipping
|
||||
options.
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetShippingOptionsParams
|
||||
@@ -32,7 +155,7 @@ get:
|
||||
- lang: tsx
|
||||
label: Medusa React
|
||||
source:
|
||||
$ref: ../code_samples/tsx/admin_shipping-options/getundefined
|
||||
$ref: ../code_samples/tsx/admin_shipping-options/get.tsx
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -82,7 +205,7 @@ post:
|
||||
- lang: tsx
|
||||
label: Medusa React
|
||||
source:
|
||||
$ref: ../code_samples/tsx/admin_shipping-options/postundefined
|
||||
$ref: ../code_samples/tsx/admin_shipping-options/post.tsx
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
Reference in New Issue
Block a user