chore(docs): Updated API Reference (automated) (#11167)
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> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
Oli Juhl
Shahed Nasser
Oli Juhl
Shahed Nasser
parent
43aa993971
commit
3e81962503
@@ -0,0 +1,699 @@
|
||||
get:
|
||||
operationId: GetProductTags
|
||||
summary: List Product Tags
|
||||
description: >-
|
||||
Retrieve a list of product tags. The product tags can be filtered by fields
|
||||
such as `id`. The product tags can also be sorted or paginated.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: x-publishable-api-key
|
||||
in: header
|
||||
description: Publishable API Key created in the Medusa Admin.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
|
||||
if a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields.
|
||||
|
||||
without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: $and
|
||||
in: query
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
required: false
|
||||
schema:
|
||||
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
|
||||
- name: $or
|
||||
in: query
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's content is the
|
||||
same type as the expected query parameters.
|
||||
required: false
|
||||
schema:
|
||||
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
|
||||
- name: q
|
||||
in: query
|
||||
description: Query to search product tag's searchable fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: Query to search product tag's searchable fields.
|
||||
- name: id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: Filter by a product tag's ID.
|
||||
- type: array
|
||||
description: Filter by product tag IDs.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: A product tag's ID.
|
||||
- name: value
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: value
|
||||
description: Filter by a product tag's value.
|
||||
- type: array
|
||||
description: Filter by product tag values.
|
||||
items:
|
||||
type: string
|
||||
title: value
|
||||
description: A product tag's value.
|
||||
- name: created_at
|
||||
in: query
|
||||
description: Filter by the tag's creation date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: Filter by the tag's creation date.
|
||||
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 multiple exact matches.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: 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: The value to match.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: The value not to match.
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: Filter by values not matching this parameter.
|
||||
- type: object
|
||||
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 multiple exact matches.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: The value to match.
|
||||
$ne:
|
||||
type: string
|
||||
title: $ne
|
||||
description: Filter by values not matching this parameter.
|
||||
$in:
|
||||
type: array
|
||||
description: Filter by values in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $in
|
||||
description: The value to match.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: The value to not match
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: Filter by values not matching this parameter
|
||||
- type: object
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
- type: array
|
||||
description: >-
|
||||
Filter by values not matching the values of this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: The values to not match.
|
||||
$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: The value to match.
|
||||
$contains:
|
||||
type: array
|
||||
description: >-
|
||||
Filter arrays that contain some of the values of this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contains
|
||||
description: The values to match.
|
||||
$contained:
|
||||
type: array
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contained
|
||||
description: The values to match.
|
||||
$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 those in this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: The values to not match.
|
||||
$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: The values to match.
|
||||
$contains:
|
||||
type: array
|
||||
description: Filter arrays that contain some of the values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contains
|
||||
description: The values to match.
|
||||
$contained:
|
||||
type: array
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contained
|
||||
description: The values to match.
|
||||
$exists:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: updated_at
|
||||
in: query
|
||||
description: Filter by the tag's update date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: Filter by the tag's update date.
|
||||
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 multiple exact matches.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: 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: The value to match.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: The value not to match.
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: Filter by values not matching this parameter.
|
||||
- type: object
|
||||
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 multiple exact matches.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: The value to match.
|
||||
$ne:
|
||||
type: string
|
||||
title: $ne
|
||||
description: Filter by values not matching this parameter.
|
||||
$in:
|
||||
type: array
|
||||
description: Filter by values in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $in
|
||||
description: The value to match.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: The value to not match
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: Filter by values not matching this parameter
|
||||
- type: object
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
- type: array
|
||||
description: >-
|
||||
Filter by values not matching the values of this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: The values to not match.
|
||||
$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: The value to match.
|
||||
$contains:
|
||||
type: array
|
||||
description: >-
|
||||
Filter arrays that contain some of the values of this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contains
|
||||
description: The values to match.
|
||||
$contained:
|
||||
type: array
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contained
|
||||
description: The values to match.
|
||||
$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 those in this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: The values to not match.
|
||||
$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: The values to match.
|
||||
$contains:
|
||||
type: array
|
||||
description: Filter arrays that contain some of the values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contains
|
||||
description: The values to match.
|
||||
$contained:
|
||||
type: array
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contained
|
||||
description: The values to match.
|
||||
$exists:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_product-tags/get.sh
|
||||
tags:
|
||||
- Product Tags
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreProductTagListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.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
|
||||
@@ -0,0 +1,68 @@
|
||||
get:
|
||||
operationId: GetProductTagsId
|
||||
summary: Get a Product Tag
|
||||
description: >-
|
||||
Retrieve a product tag by its ID. You can expand the product tag's relations
|
||||
or select the fields that should be returned.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The product tag's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: x-publishable-api-key
|
||||
in: header
|
||||
description: Publishable API Key created in the Medusa Admin.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
|
||||
if a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields.
|
||||
|
||||
without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_product-tags_{id}/get.sh
|
||||
tags:
|
||||
- Product Tags
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreProductTagResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.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
|
||||
@@ -0,0 +1,696 @@
|
||||
get:
|
||||
operationId: GetProductTypes
|
||||
summary: List Product Types
|
||||
description: >-
|
||||
Retrieve a list of product types. The product types can be filtered by
|
||||
fields such as `id`. The product types can also be sorted or paginated.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: x-publishable-api-key
|
||||
in: header
|
||||
description: Publishable API Key created in the Medusa Admin.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||
- name: fields
|
||||
in: query
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: $and
|
||||
in: query
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
required: false
|
||||
schema:
|
||||
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
|
||||
- name: $or
|
||||
in: query
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's content is the
|
||||
same type as the expected query parameters.
|
||||
required: false
|
||||
schema:
|
||||
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
|
||||
- name: q
|
||||
in: query
|
||||
description: Query to search the product type's searchable fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: Query to search the product type's searchable fields.
|
||||
- name: id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: Filter by a product type's ID.
|
||||
- type: array
|
||||
description: Filter by product type IDs.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: A product type's ID.
|
||||
- name: value
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: value
|
||||
description: Filter by a product type's value.
|
||||
- type: array
|
||||
description: Filter by product type values.
|
||||
items:
|
||||
type: string
|
||||
title: value
|
||||
description: A product type's value.
|
||||
- name: created_at
|
||||
in: query
|
||||
description: Filter by the type's creation date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: Filter by the type's creation date.
|
||||
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 multiple exact matches.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: 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: The value to match.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: The value not to match.
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: Filter by values not matching this parameter.
|
||||
- type: object
|
||||
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 multiple exact matches.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: The value to match.
|
||||
$ne:
|
||||
type: string
|
||||
title: $ne
|
||||
description: Filter by values not matching this parameter.
|
||||
$in:
|
||||
type: array
|
||||
description: Filter by values in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $in
|
||||
description: The value to match.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: The value to not match
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: Filter by values not matching this parameter
|
||||
- type: object
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
- type: array
|
||||
description: >-
|
||||
Filter by values not matching the values of this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: The values to not match.
|
||||
$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: The value to match.
|
||||
$contains:
|
||||
type: array
|
||||
description: >-
|
||||
Filter arrays that contain some of the values of this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contains
|
||||
description: The values to match.
|
||||
$contained:
|
||||
type: array
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contained
|
||||
description: The values to match.
|
||||
$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 those in this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: The values to not match.
|
||||
$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: The values to match.
|
||||
$contains:
|
||||
type: array
|
||||
description: Filter arrays that contain some of the values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contains
|
||||
description: The values to match.
|
||||
$contained:
|
||||
type: array
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contained
|
||||
description: The values to match.
|
||||
$exists:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: updated_at
|
||||
in: query
|
||||
description: Filter by the type's update date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: Filter by the type's update date.
|
||||
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 multiple exact matches.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: 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: The value to match.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: The value not to match.
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: Filter by values not matching this parameter.
|
||||
- type: object
|
||||
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 multiple exact matches.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: The value to match.
|
||||
$ne:
|
||||
type: string
|
||||
title: $ne
|
||||
description: Filter by values not matching this parameter.
|
||||
$in:
|
||||
type: array
|
||||
description: Filter by values in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $in
|
||||
description: The value to match.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: The value to not match
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: Filter by values not matching this parameter
|
||||
- type: object
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
- type: array
|
||||
description: >-
|
||||
Filter by values not matching the values of this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: The values to not match.
|
||||
$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: The value to match.
|
||||
$contains:
|
||||
type: array
|
||||
description: >-
|
||||
Filter arrays that contain some of the values of this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contains
|
||||
description: The values to match.
|
||||
$contained:
|
||||
type: array
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contained
|
||||
description: The values to match.
|
||||
$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 those in this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: The values to not match.
|
||||
$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: The values to match.
|
||||
$contains:
|
||||
type: array
|
||||
description: Filter arrays that contain some of the values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contains
|
||||
description: The values to match.
|
||||
$contained:
|
||||
type: array
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contained
|
||||
description: The values to match.
|
||||
$exists:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_product-types/get.sh
|
||||
tags:
|
||||
- Product Types
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreProductTypeListResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.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
|
||||
@@ -0,0 +1,65 @@
|
||||
get:
|
||||
operationId: GetProductTypesId
|
||||
summary: Get a Product Type
|
||||
description: >-
|
||||
Retrieve a product type by its ID. You can expand the product type's
|
||||
relations or select the fields that should be returned.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The product type's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: x-publishable-api-key
|
||||
in: header
|
||||
description: Publishable API Key created in the Medusa Admin.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||
- name: fields
|
||||
in: query
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_product-types_{id}/get.sh
|
||||
tags:
|
||||
- Product Types
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreProductTypeResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.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
|
||||
Reference in New Issue
Block a user