asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Updated API Reference (v2) (#8954)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-09-03 07:18:42 +00:00
committed by GitHub
parent 6652db45ef
commit edc19e748b
157 changed files with 16009 additions and 35955 deletions
Download Patch File Download Diff File Expand all files Collapse all files

518
www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml
View File

@@ -68,21 +68,21 @@ get:
oneOf:
- type: string
title: id
description: The shipping option's ID.
description: Filter by a shipping option ID.
- type: array
description: The shipping option's ID.
description: Filter by shipping option IDs.
items:
type: string
title: id
description: The id's ID.
description: A shipping option's ID.
- name: q
in: query
description: The shipping option's q.
description: Search term to filter the shipping option's searchable properties.
required: false
schema:
type: string
title: q
description: The shipping option's q.
description: Search term to filter the shipping option's searchable properties.
- name: service_zone_id
in: query
required: false
@@ -90,13 +90,17 @@ get:
oneOf:
- type: string
title: service_zone_id
description: The shipping option's service zone id.
description: >-
Filter by a service zone's ID to retrieve its associated shipping
options.
- type: array
description: The shipping option's service zone id.
description: >-
Filter by service zone IDs to retrieve their associated shipping
options.
items:
type: string
title: service_zone_id
description: The service zone id's details.
description: A service zone ID.
- name: shipping_profile_id
in: query
required: false
@@ -104,13 +108,17 @@ get:
oneOf:
- type: string
title: shipping_profile_id
description: The shipping option's shipping profile id.
description: >-
Filter by a shipping profile's ID to retrieve its associated
shipping options.
- type: array
description: The shipping option's shipping profile id.
description: >-
Filter by shipping profile IDs to retrieve their associated
shipping options.
items:
type: string
title: shipping_profile_id
description: The shipping profile id's details.
description: A shipping profile ID.
- name: provider_id
in: query
required: false
@@ -118,13 +126,17 @@ get:
oneOf:
- type: string
title: provider_id
description: The shipping option's provider id.
description: >-
Filter by a fulfillment provider's ID to retrieve its associated
shipping options.
- type: array
description: The shipping option's provider id.
description: >-
Filter by fulfillment provider IDs to retrieve their associated
shipping options.
items:
type: string
title: provider_id
description: The provider id's details.
description: A fulfillment provider ID.
- name: shipping_option_type_id
in: query
required: false
@@ -132,20 +144,24 @@ get:
oneOf:
- type: string
title: shipping_option_type_id
description: The shipping option's shipping option type id.
description: >-
Filter by a shipping option type's ID to retrieve its associated
shipping options.
- type: array
description: The shipping option's shipping option type id.
description: >-
Filter by shipping option type IDs to retrieve its associated
shipping options.
items:
type: string
title: shipping_option_type_id
description: The shipping option type id's details.
description: A shipping option type ID.
- name: created_at
in: query
description: The shipping option's created at.
description: Filter by a shipping option's creation date.
required: false
schema:
type: object
description: The shipping option's created at.
description: Filter by a shipping option's creation date.
properties:
$and:
type: array
@@ -203,150 +219,6 @@ get:
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
@@ -424,11 +296,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at
in: query
description: The shipping option's updated at.
description: Filter by a shipping option's update date.
required: false
schema:
type: object
description: The shipping option's updated at.
description: Filter by a shipping option's update date.
properties:
$and:
type: array
@@ -486,150 +358,6 @@ get:
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
@@ -707,11 +435,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at
in: query
description: The shipping option's deleted at.
description: Filter by a shipping option's deletion date.
required: false
schema:
type: object
description: The shipping option's deleted at.
description: Filter by a shipping option's deletion date.
properties:
$and:
type: array
@@ -769,150 +497,6 @@ get:
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
@@ -995,13 +579,17 @@ get:
oneOf:
- type: string
title: stock_location_id
description: The shipping option's stock location id.
description: >-
Filter by a location ID to retrieve its associated shipping
option.
- type: array
description: The shipping option's stock location id.
description: >-
Filter by location IDs to retrieve their associated shipping
option.
items:
type: string
title: stock_location_id
description: The stock location id's details.
description: A stock location's ID.
- name: is_return
in: query
description: The shipping option's is return.
@@ -1037,7 +625,7 @@ get:
schema:
allOf:
- type: object
description: SUMMARY
description: The paginated list of shipping options.
required:
- limit
- offset
@@ -1046,23 +634,25 @@ get:
limit:
type: number
title: limit
description: The shipping option's limit.
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The shipping option's offset.
description: >-
The number of items skipped before retrieving the returned
items.
count:
type: number
title: count
description: The shipping option's count.
description: The total number of items.
- type: object
description: SUMMARY
description: The paginated list of shipping options.
required:
- shipping_options
properties:
shipping_options:
type: array
description: The shipping option's shipping options.
description: The list of shipping options.
items:
type: object
'400':