docs: generate OAS for 2.11.2 (#13925)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-10-31 16:15:46 +02:00
1 parent 13d7d15be5
commit 604ff55a5b
403 files changed
+17473 -5392

No files matched your search

@@ -301,6 +301,13 @@ const generatedgeneratedAdminSidebarSidebar = {
"loaded": false, "loaded": false,
"showLoadingIfEmpty": true "showLoadingIfEmpty": true
}, },
{
"type": "category",
"title": "Index",
"children": [],
"loaded": false,
"showLoadingIfEmpty": true
},
{ {
"type": "category", "type": "category",
"title": "Inventory Items", "title": "Inventory Items",
@@ -0,0 +1,17 @@
import Medusa from "@medusajs/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.product.batchImageVariants("prod_123", "img_123", {
add: ["variant_123", "variant_456"],
remove: ["variant_789"]
})
.then(({ added, removed }) => {
console.log(added, removed)
})
@@ -0,0 +1,17 @@
import Medusa from "@medusajs/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.product.batchVariantImages("prod_123", "variant_123", {
add: ["img_123", "img_456"],
remove: ["img_789"]
})
.then(({ added, removed }) => {
console.log(added, removed)
})
@@ -0,0 +1,2 @@
curl '{backend_url}/admin/index/details' \
-H 'Authorization: Bearer {access_token}'
@@ -0,0 +1,6 @@
curl -X POST '{backend_url}/admin/index/sync' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"strategy": "full"
}'
@@ -0,0 +1,7 @@
curl -X POST '{backend_url}/admin/products/{id}/images/{image_id}/variants/batch' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"add": ["variant_123", "variant_456"],
"remove": ["variant_789"]
}'
@@ -0,0 +1,7 @@
curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/images/batch' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"add": ["img_123", "img_456"],
"remove": ["img_789"]
}'
@@ -1,6 +1,6 @@
type: object type: object
description: The details of the order items to add to the claim. description: The details of the order items to add to the claim.
x-schemaName: AdminPostClaimItemsReqSchema x-schemaName: AdminAddClaimItems
properties: properties:
items: items:
type: array type: array
@@ -0,0 +1,38 @@
type: object
description: The details of the outbound items to add to the claim.
x-schemaName: AdminAddClaimOutboundItems
properties:
items:
type: array
description: The outbound item's details.
items:
type: object
description: An item's details.
required:
- id
- quantity
properties:
quantity:
type: number
title: quantity
description: The quantity to send to the customer.
internal_note:
type: string
title: internal_note
description: A note viewed only by admin users.
id:
type: string
title: id
description: The item's ID.
reason:
type: string
description: The item's reason.
enum:
- missing_item
- wrong_item
- production_failure
- other
description:
type: string
title: description
description: The item's description.
@@ -1,6 +1,6 @@
type: object type: object
description: The details of the inbound (return) items. description: The details of the inbound (return) items.
x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema x-schemaName: AdminAddExchangeInboundItems
properties: properties:
items: items:
type: array type: array
@@ -1,6 +1,6 @@
type: object type: object
description: The details of outbound items. description: The details of outbound items.
x-schemaName: AdminPostExchangesAddItemsReqSchema x-schemaName: AdminAddExchangeOutboundItems
properties: properties:
items: items:
type: array type: array
@@ -0,0 +1,29 @@
type: object
description: An item's details.
required:
- id
- quantity
properties:
id:
type: string
title: id
description: The item's ID.
quantity:
type: number
title: quantity
description: The item's quantity.
description:
type: string
title: description
description: The item's description.
internal_note:
type: string
title: internal_note
description: A note viewed only by admin users.
metadata:
type: object
description: The item's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
x-schemaName: AdminAddReturnItem
@@ -0,0 +1,11 @@
type: object
description: The items' details.
x-schemaName: AdminAddReturnItems
properties:
items:
type: array
description: The items' details.
items:
$ref: ./AdminAddReturnItem.yaml
required:
- items
@@ -0,0 +1,28 @@
type: object
description: The shipping method's details.
x-schemaName: AdminAddReturnShipping
required:
- shipping_option_id
properties:
shipping_option_id:
type: string
title: shipping_option_id
description: The ID of the associated shipping option.
custom_amount:
type: number
title: custom_amount
description: Set the price of the shipping method.
description:
type: string
title: description
description: The shipping method's description.
internal_note:
type: string
title: internal_note
description: A note viewed only by admin users.
metadata:
type: object
description: The exchange's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
@@ -15,4 +15,4 @@ properties:
type: number type: number
title: incoming_quantity title: incoming_quantity
description: The inventory level's incoming quantity. description: The inventory level's incoming quantity.
x-schemaName: AdminCreateInventoryLocationLevel x-schemaName: AdminBatchCreateInventoryItemLocationLevels
@@ -0,0 +1,18 @@
type: object
description: Details of the associations between variants and a product image to manage.
x-schemaName: AdminBatchImageVariantRequest
properties:
add:
type: array
description: The IDs of product variants to add the image to.
items:
type: string
title: add
description: The ID of the variant to add.
remove:
type: array
description: The IDs of product variants to remove the image from.
items:
type: string
title: remove
description: The ID of the variant to remove.
@@ -0,0 +1,21 @@
type: object
description: Result of managing the associations between variants and a product image.
x-schemaName: AdminBatchImageVariantResponse
required:
- added
- removed
properties:
added:
type: array
description: The IDs of product variants added the image to.
items:
type: string
title: added
description: The ID of the variant added.
removed:
type: array
description: The IDs of product variants removed the image from.
items:
type: string
title: removed
description: The ID of the variant removed.
@@ -0,0 +1,18 @@
type: object
description: A batch operation to manage the associations between two entities.
properties:
add:
type: array
description: The IDs of an entity to add to the other.
items:
type: string
title: add
description: The entity's ID.
remove:
type: array
description: The IDs of an entity to remove from the other.
items:
type: string
title: remove
description: The entity's ID.
x-schemaName: AdminBatchLink
@@ -35,6 +35,10 @@ properties:
type: string type: string
title: url title: url
description: The image's URL. description: The image's URL.
id:
type: string
title: id
description: The image's ID.
thumbnail: thumbnail:
type: string type: string
title: thumbnail title: thumbnail
@@ -86,5 +86,9 @@ properties:
type: string type: string
title: id title: id
description: The update's ID. description: The update's ID.
thumbnail:
type: string
title: thumbnail
description: The variant's thumbnail.
required: required:
- id - id
@@ -0,0 +1,18 @@
type: object
description: Details of the associations between images and a product variant to manage.
x-schemaName: AdminBatchVariantImagesRequest
properties:
add:
type: array
description: The IDs of product images to add to the variant.
items:
type: string
title: add
description: The ID of the image to add.
remove:
type: array
description: The IDs of product images to remove from the variant.
items:
type: string
title: remove
description: The ID of the image to remove.
@@ -0,0 +1,21 @@
type: object
description: Result of managing the associations between images and a product variant.
x-schemaName: AdminBatchVariantImagesResponse
required:
- added
- removed
properties:
added:
type: array
description: The IDs of product images added to the variant.
items:
type: string
title: added
description: The ID of the image added.
removed:
type: array
description: The IDs of product images removed from the variant.
items:
type: string
title: removed
description: The ID of the image removed.
@@ -5,4 +5,4 @@ properties:
type: number type: number
title: amount title: amount
description: The amount to capture. description: The amount to capture.
x-schemaName: AdminCreatePaymentCapture x-schemaName: AdminCapturePayment
@@ -1,6 +1,6 @@
type: object type: object
description: The details of the shipping method used to ship outbound items. description: The details of the shipping method used to ship outbound items.
x-schemaName: AdminPostClaimsShippingReqSchema x-schemaName: AdminClaimAddOutboundShipping
required: required:
- shipping_option_id - shipping_option_id
properties: properties:
@@ -1,6 +1,6 @@
type: object type: object
description: The details to update in the shipping method. description: The details to update in the shipping method.
x-schemaName: AdminPostClaimsShippingActionReqSchema x-schemaName: AdminClaimUpdateInboundShipping
properties: properties:
custom_amount: custom_amount:
type: number type: number
@@ -1,6 +1,6 @@
type: object type: object
description: The details to update in the shipping method. description: The details to update in the shipping method.
x-schemaName: AdminPostClaimsShippingActionReqSchema x-schemaName: AdminClaimUpdateOutboundShipping
properties: properties:
custom_amount: custom_amount:
type: number type: number
@@ -1,6 +1,6 @@
type: object type: object
description: The confirmation's details. description: The confirmation's details.
x-schemaName: AdminPostReturnsConfirmRequestReqSchema x-schemaName: AdminConfirmReceiveReturn
properties: properties:
no_notification: no_notification:
type: boolean type: boolean
@@ -1,6 +1,6 @@
type: object type: object
description: The confirmation's details. description: The confirmation's details.
x-schemaName: AdminPostReturnsConfirmRequestReqSchema x-schemaName: AdminConfirmReturnRequest
properties: properties:
no_notification: no_notification:
type: boolean type: boolean
@@ -1,6 +1,6 @@
type: object type: object
description: The claim's details. description: The claim's details.
x-schemaName: AdminPostOrderClaimsReqSchema x-schemaName: AdminCreateClaim
required: required:
- type - type
- order_id - order_id
@@ -1,6 +1,6 @@
type: object type: object
description: The exchange's details. description: The exchange's details.
x-schemaName: AdminPostOrderExchangesReqSchema x-schemaName: AdminCreateExchange
required: required:
- order_id - order_id
properties: properties:
@@ -2,14 +2,12 @@ type: object
description: The filfillment's details. description: The filfillment's details.
x-schemaName: AdminCreateFulfillment x-schemaName: AdminCreateFulfillment
required: required:
- items
- metadata
- order_id
- data
- location_id - location_id
- provider_id - provider_id
- delivery_address - delivery_address
- items
- labels - labels
- order_id
properties: properties:
location_id: location_id:
type: string type: string
@@ -20,118 +18,17 @@ properties:
title: provider_id title: provider_id
description: The ID of the provider handling this fulfillment. description: The ID of the provider handling this fulfillment.
delivery_address: delivery_address:
type: object $ref: ./AdminFulfillmentDeliveryAddress.yaml
description: The address to deliver the items to.
properties:
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
phone:
type: string
title: phone
description: The customer's phone.
company:
type: string
title: company
description: The delivery address's company.
address_1:
type: string
title: address_1
description: The delivery address's first line.
address_2:
type: string
title: address_2
description: The delivery address's second line.
city:
type: string
title: city
description: The delivery address's city.
country_code:
type: string
title: country_code
description: The delivery address's country code.
province:
type: string
title: province
description: The delivery address's ISO 3166-2 province code. Must be lower-case.
example: us-ca
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_3166-2
description: Learn more about ISO 3166-2
postal_code:
type: string
title: postal_code
description: The delivery address's postal code.
metadata:
type: object
description: The delivery address's metadata, used to store custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
items: items:
type: array type: array
description: The items to fulfill. description: The items to fulfill.
items: items:
type: object $ref: ./AdminCreateFulfillmentItem.yaml
description: An item to fulfill.
required:
- title
- quantity
- sku
- barcode
properties:
title:
type: string
title: title
description: The item's title.
sku:
type: string
title: sku
description: The item's SKU.
quantity:
type: number
title: quantity
description: The quantity to fulfill of the item.
barcode:
type: string
title: barcode
description: The item's barcode.
line_item_id:
type: string
title: line_item_id
description: The ID of the associated line item.
inventory_item_id:
type: string
title: inventory_item_id
description: The ID of the inventory item associated with the underlying variant.
labels: labels:
type: array type: array
description: The labels for the fulfillment's shipments. description: The labels for the fulfillment's shipments.
items: items:
type: object $ref: ./AdminCreateFulfillmentLabel.yaml
description: A shipment's label.
required:
- tracking_number
- tracking_url
- label_url
properties:
tracking_number:
type: string
title: tracking_number
description: The label's tracking number.
tracking_url:
type: string
title: tracking_url
description: The label's tracking URL.
label_url:
type: string
title: label_url
description: The label's URL.
order_id: order_id:
type: string type: string
title: order_id title: order_id
@@ -0,0 +1,33 @@
type: object
description: An item to fulfill.
required:
- title
- sku
- quantity
- barcode
properties:
title:
type: string
title: title
description: The item's title.
sku:
type: string
title: sku
description: The item's SKU.
quantity:
type: number
title: quantity
description: The quantity to fulfill of the item.
barcode:
type: string
title: barcode
description: The item's barcode.
line_item_id:
type: string
title: line_item_id
description: The ID of the associated line item.
inventory_item_id:
type: string
title: inventory_item_id
description: The ID of the inventory item associated with the underlying variant.
x-schemaName: AdminCreateFulfillmentItem
@@ -0,0 +1,20 @@
type: object
description: Details of the fulfillment label to create.
required:
- tracking_number
- tracking_url
- label_url
properties:
tracking_number:
type: string
title: tracking_number
description: The label's tracking number.
tracking_url:
type: string
title: tracking_url
description: The label's tracking URL.
label_url:
type: string
title: label_url
description: The label's URL.
x-schemaName: AdminCreateFulfillmentLabel
@@ -1,7 +1,8 @@
type: object type: object
description: The service zone's details. description: Details of the service zone to create for the fulfillment set.
required: required:
- name - name
- geo_zones
properties: properties:
name: name:
type: string type: string
@@ -141,4 +142,4 @@ properties:
postal_expression: postal_expression:
type: object type: object
description: The geo zone's postal expression or ZIP code. description: The geo zone's postal expression or ZIP code.
x-schemaName: AdminCreateFulfillmentSetServiceZones x-schemaName: AdminCreateFulfillmentSetServiceZone
@@ -0,0 +1,11 @@
type: object
description: Details of the shipment to create for a fulfillment.
x-schemaName: AdminCreateFulfillmentShipment
required:
- labels
properties:
labels:
type: array
description: The shipment's labels.
items:
$ref: ./AdminCreateFulfillmentLabel.yaml
@@ -1,6 +1,6 @@
type: object type: object
description: The details of a credit line to add to an order. description: The details of a credit line to add to an order.
x-schemaName: AdminCreateOrderCreditLines x-schemaName: AdminCreateOrderCreditLine
required: required:
- amount - amount
- reference - reference
@@ -44,39 +44,4 @@ properties:
type: array type: array
description: The price list's prices. description: The price list's prices.
items: items:
type: object $ref: ./AdminCreatePriceListPrice.yaml
description: A price's details.
required:
- currency_code
- variant_id
- amount
properties:
currency_code:
type: string
title: currency_code
description: The price's currency code.
amount:
type: number
title: amount
description: The price's amount.
variant_id:
type: string
title: variant_id
description: The ID of the product variant this price is for.
min_quantity:
type: number
title: min_quantity
description: >-
The minimum quantity required in the cart for this price to be
applied.
max_quantity:
type: number
title: max_quantity
description: >-
The maximum quantity in the cart that shouldn't be crossed for this
price to be applied.
rules:
type: object
description: The price's rules.
example:
region_id: reg_123
@@ -0,0 +1,35 @@
type: object
description: The details of a price to be created within a price list.
required:
- currency_code
- amount
- variant_id
properties:
currency_code:
type: string
title: currency_code
description: The price's currency code.
amount:
type: number
title: amount
description: The price's amount.
variant_id:
type: string
title: variant_id
description: The ID of the product variant this price is for.
min_quantity:
type: number
title: min_quantity
description: The minimum quantity required in the cart for this price to be applied.
max_quantity:
type: number
title: max_quantity
description: >-
The maximum quantity in the cart that shouldn't be crossed for this price
to be applied.
rules:
type: object
description: The price's rules.
example:
region_id: reg_123
x-schemaName: AdminCreatePriceListPrice
@@ -1,29 +0,0 @@
type: object
description: The shipment's details.
x-schemaName: AdminCreateShipment
required:
- labels
properties:
labels:
type: array
description: The shipment's labels.
items:
type: object
description: A shipment label's details.
required:
- tracking_number
- tracking_url
- label_url
properties:
tracking_number:
type: string
title: tracking_number
description: The label's tracking number.
tracking_url:
type: string
title: tracking_url
description: The label's tracking URL.
label_url:
type: string
title: label_url
description: The label's URL.
@@ -1,8 +1,8 @@
type: object type: object
description: The fulfillment set to create. description: The fulfillment set to create.
required: required:
- type
- name - name
- type
properties: properties:
name: name:
type: string type: string
@@ -2,8 +2,8 @@ type: object
description: The details of the variant-inventory item association. description: The details of the variant-inventory item association.
x-schemaName: AdminCreateVariantInventoryItem x-schemaName: AdminCreateVariantInventoryItem
required: required:
- inventory_item_id
- required_quantity - required_quantity
- inventory_item_id
properties: properties:
required_quantity: required_quantity:
type: number type: number
@@ -0,0 +1,26 @@
type: object
description: The items details.
x-schemaName: AdminDismissItems
properties:
items:
type: array
description: The items details.
items:
type: object
description: An item's details.
required:
- id
- quantity
properties:
id:
type: string
title: id
description: The ID of the item in the order.
quantity:
type: number
title: quantity
description: The item's quantity.
internal_note:
type: string
title: internal_note
description: A note viewed only by admin users.
@@ -6,13 +6,13 @@ required:
- items - items
- shipping_methods - shipping_methods
- status - status
- currency_code
- id - id
- version - version
- region_id - region_id
- customer_id - customer_id
- sales_channel_id - sales_channel_id
- email - email
- currency_code
- payment_status - payment_status
- fulfillment_status - fulfillment_status
- summary - summary
@@ -0,0 +1,12 @@
type: object
description: The parameters for retrieving draft orders.
x-schemaName: AdminDraftOrderParams
properties:
fields:
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.
@@ -5,13 +5,13 @@ required:
- return_requested_total - return_requested_total
- order_change - order_change
- status - status
- currency_code
- id - id
- version - version
- region_id - region_id
- customer_id - customer_id
- sales_channel_id - sales_channel_id
- email - email
- currency_code
- payment_collections - payment_collections
- payment_status - payment_status
- fulfillment_status - fulfillment_status
@@ -1,6 +1,6 @@
type: object type: object
description: The outbound shipping method's details. description: The outbound shipping method's details.
x-schemaName: AdminPostExchangesShippingReqSchema x-schemaName: AdminExchangeAddOutboundShipping
required: required:
- shipping_option_id - shipping_option_id
properties: properties:
@@ -1,6 +1,6 @@
type: object type: object
description: The details of the shipping method to update. description: The details of the shipping method to update.
x-schemaName: AdminPostExchangesShippingActionReqSchema x-schemaName: AdminExchangeUpdateInboundShipping
properties: properties:
custom_amount: custom_amount:
type: number type: number
@@ -1,6 +1,6 @@
type: object type: object
description: The details of the shipping method to update. description: The details of the shipping method to update.
x-schemaName: AdminPostExchangesShippingActionReqSchema x-schemaName: AdminExchangeUpdateOutboundShipping
properties: properties:
custom_amount: custom_amount:
type: number type: number
@@ -0,0 +1,54 @@
type: object
description: The address to deliver the items to.
properties:
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
phone:
type: string
title: phone
description: The customer's phone.
company:
type: string
title: company
description: The delivery address's company.
address_1:
type: string
title: address_1
description: The delivery address's first line.
address_2:
type: string
title: address_2
description: The delivery address's second line.
city:
type: string
title: city
description: The delivery address's city.
country_code:
type: string
title: country_code
description: The delivery address's country code.
province:
type: string
title: province
description: The delivery address's ISO 3166-2 province code. Must be lower-case.
example: us-ca
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_3166-2
description: Learn more about ISO 3166-2
postal_code:
type: string
title: postal_code
description: The delivery address's postal code.
metadata:
type: object
description: The delivery address's metadata, used to store custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
x-schemaName: AdminFulfillmentDeliveryAddress
@@ -0,0 +1,11 @@
type: object
description: The index's metadata details.
x-schemaName: AdminIndexDetailsResponse
required:
- metadata
properties:
metadata:
type: array
description: The index's metadata.
items:
$ref: ./IndexInfo.yaml
@@ -0,0 +1,14 @@
type: object
description: The details of the index sync.
x-schemaName: AdminIndexSyncPayload
required:
- strategy
properties:
strategy:
type: string
description: >-
The syncing strategy. `full` indicates a full reindex, while `reset`
truncates tables and performs a fresh sync.
enum:
- full
- reset
@@ -1,6 +1,6 @@
type: object type: object
description: The return receival details. description: The return receival details.
x-schemaName: AdminPostReceiveReturnsReqSchema x-schemaName: AdminInitiateReceiveReturn
properties: properties:
internal_note: internal_note:
type: string type: string
@@ -1,6 +1,6 @@
type: object type: object
description: The return's details. description: The return's details.
x-schemaName: AdminPostReturnsReqSchema x-schemaName: AdminInitiateReturnRequest
required: required:
- order_id - order_id
properties: properties:
@@ -7,4 +7,4 @@ properties:
type: string type: string
title: order_id title: order_id
description: The ID of the order associated with the payment collection. description: The ID of the order associated with the payment collection.
x-schemaName: AdminMarkPaymentCollectionPaid x-schemaName: AdminMarkPaymentCollectionAsPaid
@@ -6,13 +6,13 @@ required:
- items - items
- shipping_methods - shipping_methods
- status - status
- currency_code
- id - id
- version - version
- region_id - region_id
- customer_id - customer_id
- sales_channel_id - sales_channel_id
- email - email
- currency_code
- payment_status - payment_status
- fulfillment_status - fulfillment_status
- summary - summary
@@ -14,7 +14,6 @@ required:
- created_at - created_at
- updated_at - updated_at
- order_id - order_id
- canceled_at
- return_id - return_id
- exchange_id - exchange_id
- claim_id - claim_id
@@ -26,6 +25,7 @@ required:
- declined_reason - declined_reason
- declined_at - declined_at
- canceled_by - canceled_by
- canceled_at
properties: properties:
id: id:
type: string type: string
@@ -7,13 +7,13 @@ required:
- return_requested_total - return_requested_total
- order_change - order_change
- status - status
- currency_code
- id - id
- version - version
- region_id - region_id
- customer_id - customer_id
- sales_channel_id - sales_channel_id
- email - email
- currency_code
- payment_collections - payment_collections
- payment_status - payment_status
- fulfillment_status - fulfillment_status
@@ -1,36 +0,0 @@
type: object
description: The details of the outbound items to add to the claim.
x-schemaName: AdminPostClaimsAddItemsReqSchema
properties:
items:
type: array
description: The outbound item's details.
items:
type: object
description: An item's details.
required:
- variant_id
- quantity
properties:
variant_id:
type: string
title: variant_id
description: The ID of the associated product variant.
quantity:
type: number
title: quantity
description: The quantity to send to the customer.
unit_price:
type: number
title: unit_price
description: The item's unit price.
internal_note:
type: string
title: internal_note
description: A note viewed only by admin users.
metadata:
type: object
description: The item's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
@@ -9,13 +9,13 @@ required:
- length - length
- title - title
- status - status
- description
- id - id
- created_at - created_at
- updated_at - updated_at
- subtitle - subtitle
- thumbnail - thumbnail
- handle - handle
- description
- is_giftcard - is_giftcard
- width - width
- weight - weight
@@ -35,6 +35,13 @@ properties:
type: number type: number
title: rank title: rank
description: The image's rank among sibling images. description: The image's rank among sibling images.
product:
type: object
variants:
type: array
description: The variants associated with the image.
items:
type: object
required: required:
- id - id
- url - url
@@ -10,6 +10,7 @@ required:
- barcode - barcode
- ean - ean
- upc - upc
- thumbnail
- allow_backorder - allow_backorder
- manage_inventory - manage_inventory
- hs_code - hs_code
@@ -144,3 +145,12 @@ properties:
description: The variant's inventory items. description: The variant's inventory items.
items: items:
$ref: ./AdminProductVariantInventoryItemLink.yaml $ref: ./AdminProductVariantInventoryItemLink.yaml
images:
type: array
description: The variant's images.
items:
$ref: ./AdminProductImage.yaml
thumbnail:
type: string
title: thumbnail
description: The variant's thumbnail.
@@ -1,6 +1,6 @@
type: object type: object
description: The items details. description: The items details.
x-schemaName: AdminPostReturnsReceiveItemsReqSchema x-schemaName: AdminReceiveItems
properties: properties:
items: items:
type: array type: array
@@ -13,4 +13,4 @@ properties:
type: string type: string
title: note title: note
description: A note to attach to the refund. description: A note to attach to the refund.
x-schemaName: AdminCreatePaymentRefund x-schemaName: AdminRefundPayment
@@ -2,9 +2,9 @@ type: object
description: The region's details. description: The region's details.
x-schemaName: AdminRegion x-schemaName: AdminRegion
required: required:
- name
- currency_code
- id - id
- currency_code
- name
properties: properties:
id: id:
type: string type: string
@@ -1,6 +1,6 @@
type: object type: object
description: The details of the request to transfer the order. description: The details of the request to transfer the order.
x-schemaName: AdminTransferOrder x-schemaName: AdminRequestOrderTransfer
required: required:
- customer_id - customer_id
properties: properties:
@@ -1,6 +1,6 @@
type: object type: object
description: The details to update in the item. description: The details to update in the item.
x-schemaName: AdminPostClaimsItemsActionReqSchema x-schemaName: AdminUpdateClaimItem
properties: properties:
quantity: quantity:
type: number type: number
@@ -1,6 +1,6 @@
type: object type: object
description: The details to update in the item. description: The details to update in the item.
x-schemaName: AdminPostClaimsItemsActionReqSchema x-schemaName: AdminUpdateClaimOutboundItem
properties: properties:
quantity: quantity:
type: number type: number
@@ -8,115 +8,9 @@ properties:
description: The customer email associated with the draft order. description: The customer email associated with the draft order.
format: email format: email
shipping_address: shipping_address:
type: object $ref: ./OrderAddress.yaml
description: The draft order's shipping address.
properties:
first_name:
type: string
title: first_name
description: The shipping address's first name.
last_name:
type: string
title: last_name
description: The shipping address's last name.
phone:
type: string
title: phone
description: The shipping address's phone.
company:
type: string
title: company
description: The shipping address's company.
address_1:
type: string
title: address_1
description: The first address line.
address_2:
type: string
title: address_2
description: The second address line.
city:
type: string
title: city
description: The shipping address's city.
country_code:
type: string
title: country_code
description: The shipping address's country code.
example: us
province:
type: string
title: province
description: The shipping address's ISO 3166-2 province code. Must be lower-case.
example: us-ca
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_3166-2
description: Learn more about ISO 3166-2
postal_code:
type: string
title: postal_code
description: The shipping address's postal code.
metadata:
type: object
description: The shipping address's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
billing_address: billing_address:
type: object $ref: ./OrderAddress.yaml
description: The draft order's billing address.
properties:
first_name:
type: string
title: first_name
description: The billing address's first name.
last_name:
type: string
title: last_name
description: The billing address's last name.
phone:
type: string
title: phone
description: The billing address's phone.
company:
type: string
title: company
description: The billing address's company.
address_1:
type: string
title: address_1
description: The first address line.
address_2:
type: string
title: address_2
description: The second address line.
city:
type: string
title: city
description: The billing address's city.
country_code:
type: string
title: country_code
description: The billing address's country code.
example: us
province:
type: string
title: province
description: The billing address's ISO 3166-2 province code. Must be lower-case.
example: us-ca
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_3166-2
description: Learn more about ISO 3166-2
postal_code:
type: string
title: postal_code
description: The billing address's postal code.
metadata:
type: object
description: The billing address's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
metadata: metadata:
type: object type: object
description: The draft order's metadata, can hold custom key-value pairs. description: The draft order's metadata, can hold custom key-value pairs.
@@ -1,6 +1,6 @@
type: object type: object
description: The details to update in an outbound item. description: The details to update in an outbound item.
x-schemaName: AdminPostExchangesItemsActionReqSchema x-schemaName: AdminUpdateExchangeOutboundItem
properties: properties:
quantity: quantity:
type: number type: number
@@ -155,4 +155,4 @@ properties:
type: string type: string
title: id title: id
description: The ID of an existing geo zone. description: The ID of an existing geo zone.
x-schemaName: AdminUpdateFulfillmentSetServiceZones x-schemaName: AdminUpdateFulfillmentSetServiceZone
@@ -9,4 +9,4 @@ properties:
type: number type: number
title: incoming_quantity title: incoming_quantity
description: The inventory level's incoming quantity. description: The inventory level's incoming quantity.
x-schemaName: AdminUpdateInventoryLocationLevel x-schemaName: AdminUpdateInventoryLevel
@@ -8,115 +8,9 @@ properties:
description: The order's email. description: The order's email.
format: email format: email
shipping_address: shipping_address:
type: object $ref: ./OrderAddress.yaml
description: The order's shipping address.
properties:
first_name:
type: string
title: first_name
description: The address's first name.
last_name:
type: string
title: last_name
description: The address's last name.
phone:
type: string
title: phone
description: The address's phone.
company:
type: string
title: company
description: The address's company.
address_1:
type: string
title: address_1
description: The address's first line.
address_2:
type: string
title: address_2
description: The address's second line.
city:
type: string
title: city
description: The address's city.
country_code:
type: string
title: country_code
description: The address's country code.
example: us
province:
type: string
title: province
description: The address's ISO 3166-2 province code. Must be lower-case.
example: us-ca
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_3166-2
description: Learn more about ISO 3166-2
postal_code:
type: string
title: postal_code
description: The address's postal code.
metadata:
type: object
description: The address's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
billing_address: billing_address:
type: object $ref: ./OrderAddress.yaml
description: The order's billing address.
properties:
first_name:
type: string
title: first_name
description: The address's first name.
last_name:
type: string
title: last_name
description: The address's last name.
phone:
type: string
title: phone
description: The address's phone.
company:
type: string
title: company
description: The address's company.
address_1:
type: string
title: address_1
description: The address's first line.
address_2:
type: string
title: address_2
description: The address's second line.
city:
type: string
title: city
description: The address's city.
country_code:
type: string
title: country_code
description: The address's country code.
example: us
province:
type: string
title: province
description: The address's ISO 3166-2 province code. Must be lower-case.
example: us-ca
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_3166-2
description: Learn more about ISO 3166-2
postal_code:
type: string
title: postal_code
description: The address's postal code.
metadata:
type: object
description: The address's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
metadata: metadata:
type: object type: object
description: The order's metadata, can hold custom key-value pairs. description: The order's metadata, can hold custom key-value pairs.
@@ -13,4 +13,10 @@ properties:
type: string type: string
title: code title: code
description: The refund reason's code. description: The refund reason's code.
x-schemaName: AdminUpdatePaymentRefundReason metadata:
type: object
description: The refund reason's metadata.
x-schemaName: AdminUpdateRefundReason
required:
- label
- code
@@ -0,0 +1,22 @@
type: object
description: The details to update in the item.
x-schemaName: AdminUpdateReturnItems
properties:
quantity:
type: number
title: quantity
description: The item's quantity.
internal_note:
type: string
title: internal_note
description: A note viewed only by admin users.
reason_id:
type: string
title: reason_id
description: The ID of the associated return reason.
metadata:
type: object
description: The claim's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
@@ -1,6 +1,6 @@
type: object type: object
description: The return's details. description: The return's details.
x-schemaName: AdminPostReturnsReturnReqSchema x-schemaName: AdminUpdateReturnRequest
properties: properties:
location_id: location_id:
type: string type: string
@@ -1,6 +1,6 @@
type: object type: object
description: The shipping method's details. description: The shipping method's details.
x-schemaName: AdminPostReturnsShippingActionReqSchema x-schemaName: AdminUpdateReturnShipping
properties: properties:
custom_amount: custom_amount:
type: number type: number
@@ -0,0 +1,209 @@
type: object
description: The properties to update in the shipping option type.
properties:
name:
type: string
title: name
description: The shipping option's name.
data:
type: object
description: The shipping option's data.
price_type:
type: string
description: The shipping option's price type.
enum:
- flat
- calculated
provider_id:
type: string
title: provider_id
description: The shipping option's provider id.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The shipping option's shipping profile id.
type:
$ref: ./AdminCreateShippingOptionType.yaml
type_id:
type: string
title: type_id
description: The shipping option's type id.
prices:
type: array
description: The shipping option's prices.
items:
oneOf:
- type: object
description: The price's prices.
x-schemaName: AdminUpdateShippingOptionPriceWithCurrency
properties:
id:
type: string
title: id
description: The price's ID.
currency_code:
type: string
title: currency_code
description: The price's currency code.
amount:
type: number
title: amount
description: The price's amount.
rules:
type: array
description: The price's rules.
items:
type: object
description: The rule's rules.
x-schemaName: PriceRule
required:
- attribute
- operator
- value
properties:
attribute:
type: string
title: attribute
description: The rule's attribute.
operator:
type: string
description: The rule's operator.
enum:
- gt
- lt
- eq
- lte
- gte
value:
type: number
title: value
description: The rule's value.
- type: object
description: The price's prices.
x-schemaName: AdminUpdateShippingOptionPriceWithRegion
properties:
id:
type: string
title: id
description: The price's ID.
region_id:
type: string
title: region_id
description: The price's region id.
amount:
type: number
title: amount
description: The price's amount.
rules:
type: array
description: The price's rules.
items:
type: object
description: The rule's rules.
x-schemaName: PriceRule
required:
- attribute
- operator
- value
properties:
attribute:
type: string
title: attribute
description: The rule's attribute.
operator:
type: string
description: The rule's operator.
enum:
- gt
- lt
- eq
- lte
- gte
value:
type: number
title: value
description: The rule's value.
rules:
type: array
description: The shipping option's rules.
items:
oneOf:
- type: object
description: The rule's rules.
x-schemaName: AdminCreateShippingOptionRule
required:
- operator
- attribute
- value
properties:
operator:
type: string
description: The rule's operator.
enum:
- gt
- lt
- eq
- ne
- in
- lte
- gte
- nin
attribute:
type: string
title: attribute
description: The rule's attribute.
value:
oneOf:
- type: string
title: value
description: The rule's value.
- type: array
description: The rule's value.
items:
type: string
title: value
description: The value's details.
- type: object
description: The rule's rules.
x-schemaName: AdminUpdateShippingOptionRule
required:
- id
- operator
- attribute
- value
properties:
id:
type: string
title: id
description: The rule's ID.
operator:
type: string
description: The rule's operator.
enum:
- gt
- lt
- eq
- ne
- in
- lte
- gte
- nin
attribute:
type: string
title: attribute
description: The rule's attribute.
value:
oneOf:
- type: string
title: value
description: The rule's value.
- type: array
description: The rule's value.
items:
type: string
title: value
description: The value's details.
metadata:
type: object
description: The shipping option's metadata.
x-schemaName: AdminUpdateShippingOption
@@ -7,51 +7,7 @@ properties:
title: name title: name
description: The stock location's name. description: The stock location's name.
address: address:
type: object $ref: ./AdminUpsertStockLocationAddress.yaml
description: >-
The stock location's address. Pass this property if you're creating a new
address to associate with the location.
required:
- address_1
- country_code
properties:
address_1:
type: string
title: address_1
description: The address's first line.
address_2:
type: string
title: address_2
description: The address's second line.
company:
type: string
title: company
description: The address's company.
city:
type: string
title: city
description: The address's city.
country_code:
type: string
title: country_code
description: The address's country code.
example: us
phone:
type: string
title: phone
description: The address's phone.
postal_code:
type: string
title: postal_code
description: The address's postal code.
province:
type: string
title: province
description: The address's ISO 3166-2 province code. Must be lower-case.
example: us-ca
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_3166-2
description: Learn more about ISO 3166-2
address_id: address_id:
type: string type: string
title: address_id title: address_id
@@ -10,24 +10,7 @@ properties:
type: array type: array
description: The store's supported currencies. description: The store's supported currencies.
items: items:
type: object $ref: ./AdminUpdateStoreSupportedCurrency.yaml
description: A store currency.
required:
- currency_code
properties:
currency_code:
type: string
title: currency_code
description: The currency's code.
example: usd
is_default:
type: boolean
title: is_default
description: Whether the currency is the default in the store.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: Whether prices using this currency are tax inclusive.
default_sales_channel_id: default_sales_channel_id:
type: string type: string
title: default_sales_channel_id title: default_sales_channel_id
@@ -0,0 +1,19 @@
type: object
description: The details to update in a supported currency of the store.
required:
- currency_code
properties:
currency_code:
type: string
title: currency_code
description: The currency's code.
example: usd
is_default:
type: boolean
title: is_default
description: Whether the currency is the default in the store.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: Whether prices using this currency are tax inclusive.
x-schemaName: AdminUpdateStoreSupportedCurrency
@@ -14,22 +14,7 @@ properties:
type: array type: array
description: The tax rate's rules. description: The tax rate's rules.
items: items:
type: object $ref: ./AdminCreateTaxRateRule.yaml
description: A tax rate rule.
required:
- reference
- reference_id
properties:
reference:
type: string
title: reference
description: The name of the table this rule references.
example: product_type
reference_id:
type: string
title: reference_id
description: The ID of the record in the table that the rule references.
example: ptyp_123
name: name:
type: string type: string
title: name title: name
@@ -51,3 +36,5 @@ properties:
externalDocs: externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata description: Learn how to manage metadata
required:
- code
@@ -8,6 +8,7 @@ required:
- barcode - barcode
- ean - ean
- upc - upc
- thumbnail
- allow_backorder - allow_backorder
- manage_inventory - manage_inventory
- hs_code - hs_code
@@ -133,3 +134,7 @@ properties:
externalDocs: externalDocs:
url: https://docs.medusajs.com/api/store#manage-metadata url: https://docs.medusajs.com/api/store#manage-metadata
description: Learn how to manage metadata description: Learn how to manage metadata
thumbnail:
type: string
title: thumbnail
description: The variant's thumbnail.
@@ -0,0 +1,43 @@
type: object
description: The index's metadata information.
x-schemaName: IndexInfo
required:
- id
- entity
- status
- fields
- updated_at
- last_synced_key
properties:
id:
type: string
title: id
description: The index's ID.
entity:
type: string
title: entity
description: The index's entity.
status:
type: string
description: The index's syncing or ingesting status.
enum:
- pending
- error
- done
- processing
fields:
type: array
description: The index's fields.
items:
type: string
title: fields
description: The index's fields.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the index was last updated.
last_synced_key:
type: string
title: last_synced_key
description: The key of the last index sync.
@@ -3,8 +3,8 @@ description: The cart's details.
x-schemaName: StoreCart x-schemaName: StoreCart
required: required:
- promotions - promotions
- currency_code
- id - id
- currency_code
- original_item_total - original_item_total
- original_item_subtotal - original_item_subtotal
- original_item_tax_total - original_item_tax_total
@@ -1,6 +1,6 @@
type: object type: object
description: The details of declining the order transfer request. description: The details of declining the order transfer request.
x-schemaName: StoreDeclineOrderTransferRequest x-schemaName: StoreDeclineOrderTransfer
required: required:
- token - token
properties: properties:
@@ -5,12 +5,12 @@ required:
- items - items
- shipping_methods - shipping_methods
- status - status
- currency_code
- id - id
- region_id - region_id
- customer_id - customer_id
- sales_channel_id - sales_channel_id
- email - email
- currency_code
- payment_status - payment_status
- fulfillment_status - fulfillment_status
- summary - summary
@@ -120,6 +120,10 @@ properties:
description: The variant's rank among its siblings. description: The variant's rank among its siblings.
calculated_price: calculated_price:
$ref: ./BaseCalculatedPriceSet.yaml $ref: ./BaseCalculatedPriceSet.yaml
thumbnail:
type: string
title: thumbnail
description: The variant's thumbnail.
required: required:
- options - options
- length - length
@@ -127,6 +131,7 @@ required:
- id - id
- created_at - created_at
- updated_at - updated_at
- thumbnail
- width - width
- weight - weight
- height - height
@@ -135,9 +140,9 @@ required:
- mid_code - mid_code
- material - material
- deleted_at - deleted_at
- sku
- barcode
- manage_inventory - manage_inventory
- allow_backorder - allow_backorder
- ean - ean
- upc - upc
- barcode
- sku
File diff suppressed because it is too large. Load diff
@@ -201,6 +201,14 @@ tags:
</Note> </Note>
x-associatedSchema: x-associatedSchema:
$ref: ./components/schemas/AdminGiftCard.yaml $ref: ./components/schemas/AdminGiftCard.yaml
- name: Index
description: >
The Index Module is a tool to perform high-performance queries across
modules, for example, to filter linked modules.
The Index Module is currently experimental and is hidden behind a feature
flag. Learn more about it and how to enable it in the [Index Module
guide](https://docs.medusajs.com/learn/fundamentals/module-links/index-module).
- name: Inventory Items - name: Inventory Items
description: | description: |
An inventory item is a stock-kept product whose inventory is managed. An inventory item is a stock-kept product whose inventory is managed.
@@ -874,6 +882,10 @@ paths:
$ref: paths/admin_gift-cards_{id}_orders.yaml $ref: paths/admin_gift-cards_{id}_orders.yaml
/admin/gift-cards/{id}/redeem: /admin/gift-cards/{id}/redeem:
$ref: paths/admin_gift-cards_{id}_redeem.yaml $ref: paths/admin_gift-cards_{id}_redeem.yaml
/admin/index/details:
$ref: paths/admin_index_details.yaml
/admin/index/sync:
$ref: paths/admin_index_sync.yaml
/admin/inventory-items: /admin/inventory-items:
$ref: paths/admin_inventory-items.yaml $ref: paths/admin_inventory-items.yaml
/admin/inventory-items/location-levels/batch: /admin/inventory-items/location-levels/batch:
@@ -1011,6 +1023,8 @@ paths:
$ref: paths/admin_products_imports_{transaction_id}_confirm.yaml $ref: paths/admin_products_imports_{transaction_id}_confirm.yaml
/admin/products/{id}: /admin/products/{id}:
$ref: paths/admin_products_{id}.yaml $ref: paths/admin_products_{id}.yaml
/admin/products/{id}/images/{image_id}/variants/batch:
$ref: paths/admin_products_{id}_images_{image_id}_variants_batch.yaml
/admin/products/{id}/options: /admin/products/{id}/options:
$ref: paths/admin_products_{id}_options.yaml $ref: paths/admin_products_{id}_options.yaml
/admin/products/{id}/options/{option_id}: /admin/products/{id}/options/{option_id}:
@@ -1023,6 +1037,8 @@ paths:
$ref: paths/admin_products_{id}_variants_inventory-items_batch.yaml $ref: paths/admin_products_{id}_variants_inventory-items_batch.yaml
/admin/products/{id}/variants/{variant_id}: /admin/products/{id}/variants/{variant_id}:
$ref: paths/admin_products_{id}_variants_{variant_id}.yaml $ref: paths/admin_products_{id}_variants_{variant_id}.yaml
/admin/products/{id}/variants/{variant_id}/images/batch:
$ref: paths/admin_products_{id}_variants_{variant_id}_images_batch.yaml
/admin/products/{id}/variants/{variant_id}/inventory-items: /admin/products/{id}/variants/{variant_id}/inventory-items:
$ref: paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml $ref: paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml
/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}: /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}:
@@ -39,23 +39,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
type: object $ref: ../components/schemas/AdminBatchLink.yaml
description: The sales channels to add or remove from the publishable API key.
properties:
add:
type: array
description: The sales channels to add to the publishable API key.
items:
type: string
title: add
description: A sales channel's ID.
remove:
type: array
description: The sales channels to remove from the publishable API key.
items:
type: string
title: remove
description: A sales channel's ID.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -65,6 +65,63 @@ get:
type: boolean type: boolean
title: with_deleted title: with_deleted
description: Whether to include deleted records in the result. description: Whether to include deleted records in the result.
- name: q
in: query
description: Apply a search query to the campaign's searchable properties.
required: false
schema:
type: string
title: q
description: Apply a search query to the campaign's searchable properties.
- name: campaign_identifier
in: query
description: Filter by a campaign identifier.
required: false
schema:
type: string
title: campaign_identifier
description: Filter by a campaign identifier.
- name: budget
in: query
description: Filter by the campaign's budget.
required: false
schema:
type: object
description: Filter by the campaign's budget.
properties:
currency_code:
type: string
title: currency_code
description: The budget's currency code.
example: usd
- 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
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -39,23 +39,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
type: object $ref: ../components/schemas/AdminBatchLink.yaml
description: The promotions to add or remove from the campaign.
properties:
add:
type: array
description: The promotions to add to the campaign.
items:
type: string
title: add
description: A promotion's ID.
remove:
type: array
description: The promotions to remove from the campaign.
items:
type: string
title: remove
description: A promotion's ID.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -59,11 +59,11 @@ get:
with `-`. with `-`.
- name: deleted_at - name: deleted_at
in: query in: query
description: The claim's deleted at. description: Filter by the claim's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The claim's deleted at. description: The claim's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -383,20 +383,20 @@ get:
oneOf: oneOf:
- type: string - type: string
title: status title: status
description: The claim's status. description: Filter by the claim's status.
- type: array - type: array
description: The claim's status. description: Filter by the claim's status.
items: items:
type: string type: string
title: status title: status
description: The status's details. description: The claim's status.
- name: created_at - name: created_at
in: query in: query
description: The claim's created at. description: Filter by the claim's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The claim's created at. description: The claim's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -675,11 +675,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The claim's updated at. description: Filter by the claim's update date.
required: false required: false
schema: schema:
type: object type: object
description: The claim's updated at. description: The claim's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -1052,6 +1052,451 @@ post:
prefix it will replace the entire default fields. prefix it will replace the entire default fields.
externalDocs: externalDocs:
url: '#select-fields-and-relations' url: '#select-fields-and-relations'
- name: id
in: query
required: false
schema:
oneOf:
- type: string
title: id
description: Filter by the claim's ID.
- type: array
description: Filter by multiple claim IDs.
items:
type: string
title: id
description: A claim ID.
- name: status
in: query
required: false
schema:
oneOf:
- type: string
title: status
description: Filter by the claim's status.
- type: array
description: Filter by multiple claim statuses.
items:
type: string
title: status
description: A claim status.
- name: created_at
in: query
description: Filter by a claim's creation date.
required: false
schema:
type: object
description: Filter by a claim'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 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`).
- name: updated_at
in: query
description: Filter by a claim's update date.
required: false
schema:
type: object
description: Filter by a claim'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 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`).
- name: deleted_at
in: query
description: Filter by a claim's deletion date.
required: false
schema:
type: object
description: Filter by a claim's deletion 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 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`).
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -1060,7 +1505,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
$ref: ../components/schemas/AdminPostOrderClaimsReqSchema.yaml $ref: ../components/schemas/AdminCreateClaim.yaml
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -39,7 +39,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
$ref: ../components/schemas/AdminPostClaimItemsReqSchema.yaml $ref: ../components/schemas/AdminAddClaimItems.yaml
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -49,7 +49,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
$ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml $ref: ../components/schemas/AdminUpdateClaimItem.yaml
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -50,7 +50,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
$ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml $ref: ../components/schemas/AdminClaimUpdateInboundShipping.yaml
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -39,7 +39,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
$ref: ../components/schemas/AdminPostClaimsAddItemsReqSchema.yaml $ref: ../components/schemas/AdminAddClaimOutboundItems.yaml
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -50,7 +50,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
$ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml $ref: ../components/schemas/AdminUpdateClaimOutboundItem.yaml
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -39,7 +39,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
$ref: ../components/schemas/AdminPostClaimsShippingReqSchema.yaml $ref: ../components/schemas/AdminClaimAddOutboundShipping.yaml
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -50,7 +50,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
$ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml $ref: ../components/schemas/AdminClaimUpdateOutboundShipping.yaml
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
Loaded 100 of 403 files, more files were not shown because too many files have changed in this diff. Show more