docs: generate OAS for 2.11.2 (#13925)
This commit is contained in:
Shahed Nasser
GitHub
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The details of the order items to add to the claim.
|
||||
x-schemaName: AdminPostClaimItemsReqSchema
|
||||
x-schemaName: AdminAddClaimItems
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The details of the outbound items to add to the claim.
|
||||
x-schemaName: AdminPostClaimsAddItemsReqSchema
|
||||
x-schemaName: AdminAddClaimOutboundItems
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
@@ -9,28 +9,30 @@ properties:
|
||||
type: object
|
||||
description: An item's details.
|
||||
required:
|
||||
- variant_id
|
||||
- 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
|
||||
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
|
||||
description: The details of the inbound (return) items.
|
||||
x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema
|
||||
x-schemaName: AdminAddExchangeInboundItems
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The details of outbound items.
|
||||
x-schemaName: AdminPostExchangesAddItemsReqSchema
|
||||
x-schemaName: AdminAddExchangeOutboundItems
|
||||
properties:
|
||||
items:
|
||||
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
|
||||
title: 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
|
||||
title: url
|
||||
description: The image's URL.
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The image's ID.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
|
||||
@@ -86,5 +86,9 @@ properties:
|
||||
type: string
|
||||
title: id
|
||||
description: The update's ID.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The variant's thumbnail.
|
||||
required:
|
||||
- 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
|
||||
title: amount
|
||||
description: The amount to capture.
|
||||
x-schemaName: AdminCreatePaymentCapture
|
||||
x-schemaName: AdminCapturePayment
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The details of the shipping method used to ship outbound items.
|
||||
x-schemaName: AdminPostClaimsShippingReqSchema
|
||||
x-schemaName: AdminClaimAddOutboundShipping
|
||||
required:
|
||||
- shipping_option_id
|
||||
properties:
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The details to update in the shipping method.
|
||||
x-schemaName: AdminPostClaimsShippingActionReqSchema
|
||||
x-schemaName: AdminClaimUpdateInboundShipping
|
||||
properties:
|
||||
custom_amount:
|
||||
type: number
|
||||
@@ -0,0 +1,18 @@
|
||||
type: object
|
||||
description: The details to update in the shipping method.
|
||||
x-schemaName: AdminClaimUpdateOutboundShipping
|
||||
properties:
|
||||
custom_amount:
|
||||
type: number
|
||||
title: custom_amount
|
||||
description: The shipping method's custom amount.
|
||||
internal_note:
|
||||
type: string
|
||||
title: internal_note
|
||||
description: A note only viewed by admin users.
|
||||
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
|
||||
description: The confirmation's details.
|
||||
x-schemaName: AdminPostReturnsConfirmRequestReqSchema
|
||||
x-schemaName: AdminConfirmReceiveReturn
|
||||
properties:
|
||||
no_notification:
|
||||
type: boolean
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: The confirmation's details.
|
||||
x-schemaName: AdminConfirmReturnRequest
|
||||
properties:
|
||||
no_notification:
|
||||
type: boolean
|
||||
title: no_notification
|
||||
description: Whether to send the customer a notification about the confirmation.
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The claim's details.
|
||||
x-schemaName: AdminPostOrderClaimsReqSchema
|
||||
x-schemaName: AdminCreateClaim
|
||||
required:
|
||||
- type
|
||||
- order_id
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The exchange's details.
|
||||
x-schemaName: AdminPostOrderExchangesReqSchema
|
||||
x-schemaName: AdminCreateExchange
|
||||
required:
|
||||
- order_id
|
||||
properties:
|
||||
@@ -2,14 +2,12 @@ type: object
|
||||
description: The filfillment's details.
|
||||
x-schemaName: AdminCreateFulfillment
|
||||
required:
|
||||
- items
|
||||
- metadata
|
||||
- order_id
|
||||
- data
|
||||
- location_id
|
||||
- provider_id
|
||||
- delivery_address
|
||||
- items
|
||||
- labels
|
||||
- order_id
|
||||
properties:
|
||||
location_id:
|
||||
type: string
|
||||
@@ -20,118 +18,17 @@ properties:
|
||||
title: provider_id
|
||||
description: The ID of the provider handling this fulfillment.
|
||||
delivery_address:
|
||||
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
|
||||
$ref: ./AdminFulfillmentDeliveryAddress.yaml
|
||||
items:
|
||||
type: array
|
||||
description: The items to fulfill.
|
||||
items:
|
||||
type: object
|
||||
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.
|
||||
$ref: ./AdminCreateFulfillmentItem.yaml
|
||||
labels:
|
||||
type: array
|
||||
description: The labels for the fulfillment's shipments.
|
||||
items:
|
||||
type: object
|
||||
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.
|
||||
$ref: ./AdminCreateFulfillmentLabel.yaml
|
||||
order_id:
|
||||
type: string
|
||||
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
|
||||
description: The service zone's details.
|
||||
description: Details of the service zone to create for the fulfillment set.
|
||||
required:
|
||||
- name
|
||||
- geo_zones
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
@@ -141,4 +142,4 @@ properties:
|
||||
postal_expression:
|
||||
type: object
|
||||
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
|
||||
description: The details of a credit line to add to an order.
|
||||
x-schemaName: AdminCreateOrderCreditLines
|
||||
x-schemaName: AdminCreateOrderCreditLine
|
||||
required:
|
||||
- amount
|
||||
- reference
|
||||
@@ -44,39 +44,4 @@ properties:
|
||||
type: array
|
||||
description: The price list's prices.
|
||||
items:
|
||||
type: object
|
||||
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
|
||||
$ref: ./AdminCreatePriceListPrice.yaml
|
||||
|
||||
@@ -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
|
||||
description: The fulfillment set to create.
|
||||
required:
|
||||
- type
|
||||
- name
|
||||
- type
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
|
||||
@@ -2,8 +2,8 @@ type: object
|
||||
description: The details of the variant-inventory item association.
|
||||
x-schemaName: AdminCreateVariantInventoryItem
|
||||
required:
|
||||
- inventory_item_id
|
||||
- required_quantity
|
||||
- inventory_item_id
|
||||
properties:
|
||||
required_quantity:
|
||||
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
|
||||
- shipping_methods
|
||||
- status
|
||||
- currency_code
|
||||
- id
|
||||
- version
|
||||
- region_id
|
||||
- customer_id
|
||||
- sales_channel_id
|
||||
- email
|
||||
- currency_code
|
||||
- payment_status
|
||||
- fulfillment_status
|
||||
- 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
|
||||
- order_change
|
||||
- status
|
||||
- currency_code
|
||||
- id
|
||||
- version
|
||||
- region_id
|
||||
- customer_id
|
||||
- sales_channel_id
|
||||
- email
|
||||
- currency_code
|
||||
- payment_collections
|
||||
- payment_status
|
||||
- fulfillment_status
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The outbound shipping method's details.
|
||||
x-schemaName: AdminPostExchangesShippingReqSchema
|
||||
x-schemaName: AdminExchangeAddOutboundShipping
|
||||
required:
|
||||
- shipping_option_id
|
||||
properties:
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The details of the shipping method to update.
|
||||
x-schemaName: AdminPostExchangesShippingActionReqSchema
|
||||
x-schemaName: AdminExchangeUpdateInboundShipping
|
||||
properties:
|
||||
custom_amount:
|
||||
type: number
|
||||
@@ -0,0 +1,18 @@
|
||||
type: object
|
||||
description: The details of the shipping method to update.
|
||||
x-schemaName: AdminExchangeUpdateOutboundShipping
|
||||
properties:
|
||||
custom_amount:
|
||||
type: number
|
||||
title: custom_amount
|
||||
description: The shipping method's custom amount.
|
||||
internal_note:
|
||||
type: string
|
||||
title: internal_note
|
||||
description: A note viewed by admin users only.
|
||||
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
|
||||
@@ -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
|
||||
description: The return receival details.
|
||||
x-schemaName: AdminPostReceiveReturnsReqSchema
|
||||
x-schemaName: AdminInitiateReceiveReturn
|
||||
properties:
|
||||
internal_note:
|
||||
type: string
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The return's details.
|
||||
x-schemaName: AdminPostReturnsReqSchema
|
||||
x-schemaName: AdminInitiateReturnRequest
|
||||
required:
|
||||
- order_id
|
||||
properties:
|
||||
@@ -7,4 +7,4 @@ properties:
|
||||
type: string
|
||||
title: order_id
|
||||
description: The ID of the order associated with the payment collection.
|
||||
x-schemaName: AdminMarkPaymentCollectionPaid
|
||||
x-schemaName: AdminMarkPaymentCollectionAsPaid
|
||||
@@ -6,13 +6,13 @@ required:
|
||||
- items
|
||||
- shipping_methods
|
||||
- status
|
||||
- currency_code
|
||||
- id
|
||||
- version
|
||||
- region_id
|
||||
- customer_id
|
||||
- sales_channel_id
|
||||
- email
|
||||
- currency_code
|
||||
- payment_status
|
||||
- fulfillment_status
|
||||
- summary
|
||||
|
||||
@@ -14,7 +14,6 @@ required:
|
||||
- created_at
|
||||
- updated_at
|
||||
- order_id
|
||||
- canceled_at
|
||||
- return_id
|
||||
- exchange_id
|
||||
- claim_id
|
||||
@@ -26,6 +25,7 @@ required:
|
||||
- declined_reason
|
||||
- declined_at
|
||||
- canceled_by
|
||||
- canceled_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -7,13 +7,13 @@ required:
|
||||
- return_requested_total
|
||||
- order_change
|
||||
- status
|
||||
- currency_code
|
||||
- id
|
||||
- version
|
||||
- region_id
|
||||
- customer_id
|
||||
- sales_channel_id
|
||||
- email
|
||||
- currency_code
|
||||
- payment_collections
|
||||
- payment_status
|
||||
- fulfillment_status
|
||||
|
||||
@@ -9,13 +9,13 @@ required:
|
||||
- length
|
||||
- title
|
||||
- status
|
||||
- description
|
||||
- id
|
||||
- created_at
|
||||
- updated_at
|
||||
- subtitle
|
||||
- thumbnail
|
||||
- handle
|
||||
- description
|
||||
- is_giftcard
|
||||
- width
|
||||
- weight
|
||||
|
||||
@@ -35,6 +35,13 @@ properties:
|
||||
type: number
|
||||
title: rank
|
||||
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:
|
||||
- id
|
||||
- url
|
||||
|
||||
@@ -10,6 +10,7 @@ required:
|
||||
- barcode
|
||||
- ean
|
||||
- upc
|
||||
- thumbnail
|
||||
- allow_backorder
|
||||
- manage_inventory
|
||||
- hs_code
|
||||
@@ -144,3 +145,12 @@ properties:
|
||||
description: The variant's inventory items.
|
||||
items:
|
||||
$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
|
||||
description: The items details.
|
||||
x-schemaName: AdminPostReturnsReceiveItemsReqSchema
|
||||
x-schemaName: AdminReceiveItems
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
@@ -13,4 +13,4 @@ properties:
|
||||
type: string
|
||||
title: note
|
||||
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.
|
||||
x-schemaName: AdminRegion
|
||||
required:
|
||||
- name
|
||||
- currency_code
|
||||
- id
|
||||
- currency_code
|
||||
- name
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The details of the request to transfer the order.
|
||||
x-schemaName: AdminTransferOrder
|
||||
x-schemaName: AdminRequestOrderTransfer
|
||||
required:
|
||||
- customer_id
|
||||
properties:
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The details to update in the item.
|
||||
x-schemaName: AdminPostClaimsItemsActionReqSchema
|
||||
x-schemaName: AdminUpdateClaimItem
|
||||
properties:
|
||||
quantity:
|
||||
type: number
|
||||
@@ -0,0 +1,16 @@
|
||||
type: object
|
||||
description: The details to update in the item.
|
||||
x-schemaName: AdminUpdateClaimOutboundItem
|
||||
properties:
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
reason_id:
|
||||
type: string
|
||||
title: reason_id
|
||||
description: The ID of the return reason associated with the item.
|
||||
internal_note:
|
||||
type: string
|
||||
title: internal_note
|
||||
description: A note that's only viewed by admin users.
|
||||
@@ -8,115 +8,9 @@ properties:
|
||||
description: The customer email associated with the draft order.
|
||||
format: email
|
||||
shipping_address:
|
||||
type: object
|
||||
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
|
||||
$ref: ./OrderAddress.yaml
|
||||
billing_address:
|
||||
type: object
|
||||
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
|
||||
$ref: ./OrderAddress.yaml
|
||||
metadata:
|
||||
type: object
|
||||
description: The draft order's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The details to update in an outbound item.
|
||||
x-schemaName: AdminPostExchangesItemsActionReqSchema
|
||||
x-schemaName: AdminUpdateExchangeOutboundItem
|
||||
properties:
|
||||
quantity:
|
||||
type: number
|
||||
@@ -155,4 +155,4 @@ properties:
|
||||
type: string
|
||||
title: id
|
||||
description: The ID of an existing geo zone.
|
||||
x-schemaName: AdminUpdateFulfillmentSetServiceZones
|
||||
x-schemaName: AdminUpdateFulfillmentSetServiceZone
|
||||
@@ -9,4 +9,4 @@ properties:
|
||||
type: number
|
||||
title: 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.
|
||||
format: email
|
||||
shipping_address:
|
||||
type: object
|
||||
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
|
||||
$ref: ./OrderAddress.yaml
|
||||
billing_address:
|
||||
type: object
|
||||
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
|
||||
$ref: ./OrderAddress.yaml
|
||||
metadata:
|
||||
type: object
|
||||
description: The order's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -13,4 +13,10 @@ properties:
|
||||
type: string
|
||||
title: 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
|
||||
description: The return's details.
|
||||
x-schemaName: AdminPostReturnsReturnReqSchema
|
||||
x-schemaName: AdminUpdateReturnRequest
|
||||
properties:
|
||||
location_id:
|
||||
type: string
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The shipping method's details.
|
||||
x-schemaName: AdminPostReturnsShippingActionReqSchema
|
||||
x-schemaName: AdminUpdateReturnShipping
|
||||
properties:
|
||||
custom_amount:
|
||||
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
|
||||
description: The stock location's name.
|
||||
address:
|
||||
type: object
|
||||
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
|
||||
$ref: ./AdminUpsertStockLocationAddress.yaml
|
||||
address_id:
|
||||
type: string
|
||||
title: address_id
|
||||
|
||||
@@ -10,24 +10,7 @@ properties:
|
||||
type: array
|
||||
description: The store's supported currencies.
|
||||
items:
|
||||
type: object
|
||||
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.
|
||||
$ref: ./AdminUpdateStoreSupportedCurrency.yaml
|
||||
default_sales_channel_id:
|
||||
type: string
|
||||
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
|
||||
description: The tax rate's rules.
|
||||
items:
|
||||
type: object
|
||||
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
|
||||
$ref: ./AdminCreateTaxRateRule.yaml
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
@@ -51,3 +36,5 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
required:
|
||||
- code
|
||||
|
||||
@@ -8,6 +8,7 @@ required:
|
||||
- barcode
|
||||
- ean
|
||||
- upc
|
||||
- thumbnail
|
||||
- allow_backorder
|
||||
- manage_inventory
|
||||
- hs_code
|
||||
@@ -133,3 +134,7 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/store#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
|
||||
required:
|
||||
- promotions
|
||||
- currency_code
|
||||
- id
|
||||
- currency_code
|
||||
- original_item_total
|
||||
- original_item_subtotal
|
||||
- original_item_tax_total
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: The details of declining the order transfer request.
|
||||
x-schemaName: StoreDeclineOrderTransferRequest
|
||||
x-schemaName: StoreDeclineOrderTransfer
|
||||
required:
|
||||
- token
|
||||
properties:
|
||||
@@ -5,12 +5,12 @@ required:
|
||||
- items
|
||||
- shipping_methods
|
||||
- status
|
||||
- currency_code
|
||||
- id
|
||||
- region_id
|
||||
- customer_id
|
||||
- sales_channel_id
|
||||
- email
|
||||
- currency_code
|
||||
- payment_status
|
||||
- fulfillment_status
|
||||
- summary
|
||||
|
||||
@@ -120,6 +120,10 @@ properties:
|
||||
description: The variant's rank among its siblings.
|
||||
calculated_price:
|
||||
$ref: ./BaseCalculatedPriceSet.yaml
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The variant's thumbnail.
|
||||
required:
|
||||
- options
|
||||
- length
|
||||
@@ -127,6 +131,7 @@ required:
|
||||
- id
|
||||
- created_at
|
||||
- updated_at
|
||||
- thumbnail
|
||||
- width
|
||||
- weight
|
||||
- height
|
||||
@@ -135,9 +140,9 @@ required:
|
||||
- mid_code
|
||||
- material
|
||||
- deleted_at
|
||||
- sku
|
||||
- barcode
|
||||
- manage_inventory
|
||||
- allow_backorder
|
||||
- ean
|
||||
- upc
|
||||
- barcode
|
||||
- sku
|
||||
|
||||
Reference in New Issue
Block a user