chore(docs): Generated API Reference (#5601)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-10 14:27:17 +02:00
committed by GitHub
parent 02e2ee4e8a
commit 01d4047976
496 changed files with 1456 additions and 867 deletions

View File

@@ -15,6 +15,7 @@ properties:
example: 16128234334802
company:
type: string
description: Company
address_1:
description: Address line 1
type: string

View File

@@ -1,4 +1,5 @@
type: object
description: The user's details.
required:
- user
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The batch job's details.
required:
- batch_job
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The access token of the user, if they're authenticated successfully.
properties:
access_token:
description: Access token that can be used to send authenticated requests.

View File

@@ -1,4 +1,5 @@
type: object
description: The collection's details.
x-expanded-relations:
field: collection
relations:
@@ -7,5 +8,5 @@ required:
- collection
properties:
collection:
type: Product Collection details.
description: Product Collection details.
$ref: ./ProductCollection.yaml

View File

@@ -1,4 +1,5 @@
type: object
description: List of currencies with pagination fields.
required:
- currencies
- count

View File

@@ -1,4 +1,5 @@
type: object
description: A currency's details.
required:
- currency
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The customer group's details.
required:
- customer_group
properties:

View File

@@ -1,3 +1,4 @@
description: The list of customers with pagination fields.
type: object
required:
- customers

View File

@@ -1,4 +1,5 @@
type: object
description: The customer's details.
x-expanded-relations:
field: customer
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The resources to remove.
required:
- resources
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: Deletion operation details
required:
- id
- object

View File

@@ -1,4 +1,5 @@
type: object
description: Product types to remove from the tax rates.
required:
- product_types
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of discounts with pagination fields.
x-expanded-relations:
field: discounts
relations:
@@ -14,6 +15,7 @@ required:
properties:
discounts:
type: array
description: The list of discounts.
items:
$ref: ./Discount.yaml
count:

View File

@@ -1,4 +1,5 @@
type: object
description: The discount's details.
x-expanded-relations:
field: discount
relations:

View File

@@ -1,3 +1,4 @@
description: The list of draft orders with pagination fields.
type: object
x-expanded-relations:
field: draft_orders

View File

@@ -1,4 +1,5 @@
type: object
description: The list of draft orders.
x-expanded-relations:
field: draft_order
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The store's details with additional details like payment and tax providers.
x-expanded-relations:
field: store
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of fulfillment options in a region.
required:
- fulfillment_options
properties:

View File

@@ -1,6 +1,7 @@
type: object
description: The variant's inventory details.
properties:
variant:
type: object
description: The product variant's.
description: The product variant's inventory details.
$ref: ./VariantInventory.yaml

View File

@@ -1,4 +1,5 @@
type: object
description: The list of gift cards with pagination fields.
x-expanded-relations:
field: gift_cards
relations:
@@ -15,6 +16,7 @@ required:
properties:
gift_cards:
type: array
description: The list of gift cards.
items:
$ref: ./GiftCard.yaml
count:

View File

@@ -1,4 +1,5 @@
type: object
description: The gift card's details.
x-expanded-relations:
field: gift_card
relations:

View File

@@ -1,15 +1,18 @@
type: object
description: Details of inventory items and their associated location levels.
required:
- inventory_item
properties:
inventory_item:
type: object
description: An inventory item's ID and associated location levels.
required:
- id
- location_levels
properties:
id:
description: The id of the location
type: string
location_levels:
description: List of stock levels at a given location
type: array

View File

@@ -1,4 +1,5 @@
type: object
description: The inventory item's details.
required:
- inventory_item
properties:

View File

@@ -1,3 +1,4 @@
description: The list of invites.
type: object
required:
- invites

View File

@@ -1,4 +1,5 @@
type: object
description: The list of notes with pagination fields.
required:
- notes
- count

View File

@@ -1,4 +1,5 @@
type: object
description: The note's details.
required:
- note
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The notification's details.
x-expanded-relations:
field: notification
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The details of deleting order edit item changes.
required:
- id
- object

View File

@@ -1,4 +1,5 @@
type: object
description: The list of order edits with pagination fields.
x-expanded-relations:
field: order_edits
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The order edit details.
x-expanded-relations:
field: order_edit
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of orders with pagination fields.
x-expanded-relations:
field: orders
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The order's details.
x-expanded-relations:
field: order
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The details of deleting a payment collection.
required:
- id
- object

View File

@@ -1,4 +1,5 @@
type: object
description: The list of payment providers in a store.
required:
- payment_providers
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The payment's details.
required:
- payment
properties:

View File

@@ -11,5 +11,5 @@ properties:
- id
properties:
id:
description: The id of the item
description: The ID of the item
type: string

View File

@@ -1,4 +1,5 @@
type: object
description: The order's details.
required:
- order
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The attributes to update in an inventory item.
properties:
hs_code:
description: >-
@@ -42,6 +43,15 @@ properties:
The length of the Inventory Item. May be used in shipping rate
calculations.
type: number
title:
description: The inventory item's title.
type: string
description:
description: The inventory item's description.
type: string
thumbnail:
description: The inventory item's thumbnail.
type: string
requires_shipping:
description: Whether the item requires shipping.
type: boolean

View File

@@ -72,6 +72,15 @@ properties:
used by Fulfillment Providers to pass customs information to shipping
carriers.
type: string
title:
description: The inventory item's title.
type: string
description:
description: The inventory item's description.
type: string
thumbnail:
description: The inventory item's thumbnail.
type: string
metadata:
description: An optional set of key-value pairs with additional information.
type: object

View File

@@ -1,4 +1,5 @@
type: object
description: The details of the invite to be accepted.
required:
- token
- user

View File

@@ -12,3 +12,6 @@ properties:
If set to `true`, no notification will be sent to the customer related to
this Claim.
type: boolean
location_id:
description: The ID of the fulfillment's location.
type: string

View File

@@ -1,4 +1,5 @@
type: object
description: The details of the claim to be created.
required:
- type
- claim_items
@@ -111,6 +112,9 @@ properties:
no_notification:
description: If set to true no notification will be send related to this Claim.
type: boolean
return_location_id:
description: The ID of the location used for the associated return.
type: string
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object

View File

@@ -1,4 +1,5 @@
type: object
description: The details of the fulfillment to be created.
required:
- items
properties:
@@ -17,6 +18,9 @@ properties:
quantity:
description: The quantity of the Line Item to fulfill.
type: integer
location_id:
type: string
description: The ID of the location where the items will be fulfilled from.
no_notification:
description: >-
If set to `true`, no notification will be sent to the customer related to

View File

@@ -1,7 +1,7 @@
type: object
properties:
email:
description: the email associated with the order
description: The email associated with the order
type: string
billing_address:
description: The order's billing address

View File

@@ -50,3 +50,6 @@ properties:
refund:
description: The amount to refund.
type: integer
location_id:
description: The ID of the location used for the return.
type: string

View File

@@ -1,4 +1,5 @@
type: object
description: The shipping method's details.
required:
- price
- option_id
@@ -9,7 +10,7 @@ properties:
option_id:
type: string
description: The ID of the Shipping Option to create the Shipping Method from.
date:
data:
type: object
description: >-
The data required for the Shipping Option to create a Shipping Method.

View File

@@ -50,6 +50,9 @@ properties:
quantity:
description: The quantity of the Product Variant.
type: integer
sales_channel_id:
type: string
description: The ID of the sales channel associated with the swap.
custom_shipping_options:
description: >-
An array of custom shipping options to potentially create a Shipping
@@ -72,6 +75,9 @@ properties:
If set to `true`, no notification will be sent to the customer related to
this Swap.
type: boolean
return_location_id:
type: string
description: The ID of the location used for the associated return.
allow_backorder:
description: If set to `true`, swaps can be completed with items out of stock
type: boolean

View File

@@ -12,3 +12,6 @@ properties:
If set to `true`, no notification will be sent to the customer related to
this swap.
type: boolean
location_id:
description: The ID of the fulfillment's location.
type: string

View File

@@ -246,6 +246,9 @@ properties:
width:
description: The width of the Product.
type: number
hs_code:
description: The Harmonized System code of the product variant.
type: string
origin_country:
description: The country of origin of the Product.
type: string

View File

@@ -16,6 +16,9 @@ properties:
quantity:
description: The quantity to reserve.
type: number
description:
description: The reservation's description.
type: string
metadata:
description: An optional set of key-value pairs with additional information.
type: object

View File

@@ -6,6 +6,9 @@ properties:
quantity:
description: The quantity to reserve.
type: number
description:
description: The reservation's description.
type: string
metadata:
description: An optional set of key-value pairs with additional information.
type: object

View File

@@ -20,3 +20,6 @@ properties:
refund:
description: The amount to refund.
type: number
location_id:
description: The ID of the location to return items from.
type: string

View File

@@ -13,3 +13,10 @@ properties:
- default
- gift_card
- custom
metadata:
description: An optional set of key-value pairs with additional information.
type: object
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute

View File

@@ -16,4 +16,5 @@ properties:
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
address:
description: The data of an associated address to create or update.
$ref: ./StockLocationAddressInput.yaml

View File

@@ -19,7 +19,7 @@ properties:
description: Stock location address' city
example: Mexico city
country_code:
description: The 2 character ISO code for the country.
description: The two character ISO code for the country.
type: string
externalDocs:
url: >-

View File

@@ -1,4 +1,5 @@
type: object
description: The product types to add to the tax rate.
required:
- product_types
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The details of deleting a price list.
required:
- ids
- object
@@ -6,9 +7,10 @@ required:
properties:
ids:
type: array
description: The IDs of the deleted prices.
items:
type: string
description: The IDs of the deleted prices.
description: The ID of a deleted price.
object:
type: string
description: >-

View File

@@ -1,4 +1,5 @@
type: object
description: The price list's details.
x-expanded-relations:
field: price_list
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of price lists with pagination fields.
required:
- price_lists
- count

View File

@@ -1,4 +1,5 @@
type: object
description: The list of products with pagination fields.
x-expanded-relations:
field: products
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The product category's details.
x-expanded-relations:
field: product_category
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of product categories with pagination fields.
x-expanded-relations:
field: product_categories
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of product tags with pagination fields.
required:
- product_tags
- count

View File

@@ -1,4 +1,5 @@
type: object
description: The list of product types with pagination fields.
required:
- product_types
- count

View File

@@ -1,4 +1,5 @@
type: object
description: The details of deleting a product's option.
x-expanded-relations:
field: product
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The details of deleting a product.
required:
- id
- object

View File

@@ -1,4 +1,5 @@
type: object
description: The details of deleting a product's variant.
x-expanded-relations:
field: product
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of products with pagination fields.
x-expanded-relations:
field: products
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The usage details of product tags.
required:
- tags
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The product's details.
x-expanded-relations:
field: product
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of publishable API keys with pagination fields.
required:
- publishable_api_keys
- count

View File

@@ -1,4 +1,5 @@
type: object
description: The list of sales channel.
required:
- sales_channels
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The publishable API key's details.
required:
- publishable_api_key
properties:

View File

@@ -1,7 +1,8 @@
type: object
description: The refund's details.
required:
- refund
properties:
refund:
description: Refund details
description: Refund details.
$ref: ./Refund.yaml

View File

@@ -1,4 +1,5 @@
type: object
description: The list of regions with pagination fields.
x-expanded-relations:
field: regions
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The region's details.
x-expanded-relations:
field: region
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of reservations with pagination fields.
required:
- reservations
- count

View File

@@ -1,4 +1,5 @@
type: object
description: The reservation's details.
required:
- reservation
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of return reasons.
x-expanded-relations:
field: return_reasons
relations:
@@ -9,5 +10,6 @@ required:
properties:
return_reasons:
type: array
description: The list of return reasons.
items:
$ref: ./ReturnReason.yaml

View File

@@ -1,4 +1,5 @@
type: object
description: The return reason's details.
x-expanded-relations:
field: return_reason
relations:
@@ -8,4 +9,5 @@ required:
- return_reason
properties:
return_reason:
description: The return reason's details.
$ref: ./ReturnReason.yaml

View File

@@ -1,4 +1,5 @@
type: object
description: The associated order's details.
x-expanded-relations:
field: order
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of returns with pagination fields.
x-expanded-relation:
field: returns
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The return's details.
x-expanded-relation:
field: return
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of sales channels with pagination fields.
required:
- sales_channels
- count

View File

@@ -1,4 +1,5 @@
type: object
description: The sales channel's details.
required:
- sales_channel
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of shipping options with pagination fields.
x-expanded-relations:
field: shipping_options
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The shipping option's details.
x-expanded-relations:
field: shipping_option
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of shipping profiles.
required:
- shipping_profiles
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The shipping profile's details.
x-expanded-relations:
field: shipping_profile
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of stock locations with pagination fields.
required:
- stock_locations
- count

View File

@@ -1,4 +1,5 @@
type: object
description: The stock location's details.
required:
- stock_location
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The store's details.
required:
- store
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of swaps with pagination fields.
required:
- swaps
- count

View File

@@ -1,4 +1,5 @@
type: object
description: The swap's details.
x-expanded-relations:
field: swap
relations:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of tax providers in a store.
required:
- tax_providers
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of tax rates with pagination fields.
required:
- tax_rates
- count

View File

@@ -1,4 +1,5 @@
type: object
description: The tax rate's details.
required:
- tax_rate
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The download URL details.
required:
- download_url
properties:

View File

@@ -1,4 +1,5 @@
type: object
description: The list of uploaded files.
required:
- uploads
properties:

Some files were not shown because too many files have changed in this diff Show More