diff --git a/www/apps/api-reference/generated/generated-admin-sidebar.mjs b/www/apps/api-reference/generated/generated-admin-sidebar.mjs index 989e3278fd..b2251c5e2f 100644 --- a/www/apps/api-reference/generated/generated-admin-sidebar.mjs +++ b/www/apps/api-reference/generated/generated-admin-sidebar.mjs @@ -301,6 +301,13 @@ const generatedgeneratedAdminSidebarSidebar = { "loaded": false, "showLoadingIfEmpty": true }, + { + "type": "category", + "title": "Index", + "children": [], + "loaded": false, + "showLoadingIfEmpty": true + }, { "type": "category", "title": "Inventory Items", diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_images_{image_id}_variants_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_images_{image_id}_variants_batch/post.js new file mode 100644 index 0000000000..2df4ed78e4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_images_{image_id}_variants_batch/post.js @@ -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) +}) \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}_images_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}_images_batch/post.js new file mode 100644 index 0000000000..0b99b4488e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}_images_batch/post.js @@ -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) +}) \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_index_details/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_index_details/get.sh new file mode 100644 index 0000000000..dc7a139635 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_index_details/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/index/details' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_index_sync/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_index_sync/post.sh new file mode 100644 index 0000000000..41972770f9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_index_sync/post.sh @@ -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" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_images_{image_id}_variants_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_images_{image_id}_variants_batch/post.sh new file mode 100644 index 0000000000..63d4b73e04 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_images_{image_id}_variants_batch/post.sh @@ -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"] +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_images_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_images_batch/post.sh new file mode 100644 index 0000000000..6659e4debc --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_images_batch/post.sh @@ -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"] +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAddClaimItems.yaml similarity index 95% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminAddClaimItems.yaml index d1dfd8929f..e09fc88341 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminAddClaimItems.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminAddClaimOutboundItems.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAddClaimOutboundItems.yaml new file mode 100644 index 0000000000..8335751c69 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminAddClaimOutboundItems.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAddExchangeInboundItems.yaml similarity index 95% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminAddExchangeInboundItems.yaml index 9056f17eb7..c5cc27d80e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminAddExchangeInboundItems.yaml @@ -1,6 +1,6 @@ type: object description: The details of the inbound (return) items. -x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema +x-schemaName: AdminAddExchangeInboundItems properties: items: type: array diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAddExchangeOutboundItems.yaml similarity index 96% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminAddExchangeOutboundItems.yaml index 33f64855b3..d732d715b5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminAddExchangeOutboundItems.yaml @@ -1,6 +1,6 @@ type: object description: The details of outbound items. -x-schemaName: AdminPostExchangesAddItemsReqSchema +x-schemaName: AdminAddExchangeOutboundItems properties: items: type: array diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminAddReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAddReturnItem.yaml new file mode 100644 index 0000000000..fb0cb59185 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminAddReturnItem.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminAddReturnItems.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAddReturnItems.yaml new file mode 100644 index 0000000000..09f668e3b9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminAddReturnItems.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminAddReturnShipping.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAddReturnShipping.yaml new file mode 100644 index 0000000000..296fcffc1e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminAddReturnShipping.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryLocationLevel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchCreateInventoryItemLocationLevels.yaml similarity index 88% rename from www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryLocationLevel.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminBatchCreateInventoryItemLocationLevels.yaml index 6578c122f4..7e44fb47de 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryLocationLevel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchCreateInventoryItemLocationLevels.yaml @@ -15,4 +15,4 @@ properties: type: number title: incoming_quantity description: The inventory level's incoming quantity. -x-schemaName: AdminCreateInventoryLocationLevel +x-schemaName: AdminBatchCreateInventoryItemLocationLevels diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchImageVariantRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchImageVariantRequest.yaml new file mode 100644 index 0000000000..c1a63fa4fe --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchImageVariantRequest.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchImageVariantResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchImageVariantResponse.yaml new file mode 100644 index 0000000000..afa618f4a4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchImageVariantResponse.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchLink.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchLink.yaml new file mode 100644 index 0000000000..7549ac6abe --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchLink.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml index c59675a8e7..a0c8e38bd7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProductVariant.yaml index bd4043cb70..12f78901ed 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProductVariant.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchVariantImagesRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchVariantImagesRequest.yaml new file mode 100644 index 0000000000..98fa50c7ca --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchVariantImagesRequest.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchVariantImagesResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchVariantImagesResponse.yaml new file mode 100644 index 0000000000..c5606dfcec --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchVariantImagesResponse.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePaymentCapture.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCapturePayment.yaml similarity index 78% rename from www/apps/api-reference/specs/store/components/schemas/AdminCreatePaymentCapture.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCapturePayment.yaml index 0064576c86..3bca2425ab 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePaymentCapture.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCapturePayment.yaml @@ -5,4 +5,4 @@ properties: type: number title: amount description: The amount to capture. -x-schemaName: AdminCreatePaymentCapture +x-schemaName: AdminCapturePayment diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimAddOutboundShipping.yaml similarity index 94% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminClaimAddOutboundShipping.yaml index ec629bd78a..5dc671b0fc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimAddOutboundShipping.yaml @@ -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: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimUpdateInboundShipping.yaml similarity index 91% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminClaimUpdateInboundShipping.yaml index d16214b606..1f0fb5b06a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimUpdateInboundShipping.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimUpdateOutboundShipping.yaml similarity index 91% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminClaimUpdateOutboundShipping.yaml index d16214b606..235b786124 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimUpdateOutboundShipping.yaml @@ -1,6 +1,6 @@ type: object description: The details to update in the shipping method. -x-schemaName: AdminPostClaimsShippingActionReqSchema +x-schemaName: AdminClaimUpdateOutboundShipping properties: custom_amount: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminConfirmReceiveReturn.yaml similarity index 79% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminConfirmReceiveReturn.yaml index afc9e7a3f1..7b3af414de 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminConfirmReceiveReturn.yaml @@ -1,6 +1,6 @@ type: object description: The confirmation's details. -x-schemaName: AdminPostReturnsConfirmRequestReqSchema +x-schemaName: AdminConfirmReceiveReturn properties: no_notification: type: boolean diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminConfirmReturnRequest.yaml similarity index 79% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminConfirmReturnRequest.yaml index afc9e7a3f1..24d917c3e4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminConfirmReturnRequest.yaml @@ -1,6 +1,6 @@ type: object description: The confirmation's details. -x-schemaName: AdminPostReturnsConfirmRequestReqSchema +x-schemaName: AdminConfirmReturnRequest properties: no_notification: type: boolean diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateClaim.yaml similarity index 95% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateClaim.yaml index b828e16fa2..384fe91e8a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateClaim.yaml @@ -1,6 +1,6 @@ type: object description: The claim's details. -x-schemaName: AdminPostOrderClaimsReqSchema +x-schemaName: AdminCreateClaim required: - type - order_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateExchange.yaml similarity index 93% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateExchange.yaml index f6f32aad33..ec14af98f8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateExchange.yaml @@ -1,6 +1,6 @@ type: object description: The exchange's details. -x-schemaName: AdminPostOrderExchangesReqSchema +x-schemaName: AdminCreateExchange required: - order_id properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml index 31eec6b3ef..131c73f63d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentItem.yaml new file mode 100644 index 0000000000..302de95181 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentItem.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentLabel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentLabel.yaml new file mode 100644 index 0000000000..6b6d0a6bdd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentLabel.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentSetServiceZone.yaml similarity index 97% rename from www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentSetServiceZone.yaml index 4d3d7c2ae0..305e2f1ec4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentSetServiceZone.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentShipment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentShipment.yaml new file mode 100644 index 0000000000..6e30221d01 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentShipment.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLines.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLine.yaml similarity index 94% rename from www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLines.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLine.yaml index edb07be15c..6db8d2d200 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLines.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLine.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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml index 8ff435ab5c..5f8378f8d4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceListPrice.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceListPrice.yaml new file mode 100644 index 0000000000..1d15effb6f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShipment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShipment.yaml deleted file mode 100644 index 92a29e274b..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShipment.yaml +++ /dev/null @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocationFulfillmentSet.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocationFulfillmentSet.yaml index f099300601..a849e83fb2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocationFulfillmentSet.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocationFulfillmentSet.yaml @@ -1,8 +1,8 @@ type: object description: The fulfillment set to create. required: - - type - name + - type properties: name: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml index 2de3fc7b23..23e84a8328 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDismissItems.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDismissItems.yaml new file mode 100644 index 0000000000..a22fe6e81b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDismissItems.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml index 808b078423..cd53e5a4d8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderParams.yaml new file mode 100644 index 0000000000..16568ad6fa --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderParams.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml index af04f3b1ab..e27218145f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeAddOutboundShipping.yaml similarity index 94% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminExchangeAddOutboundShipping.yaml index 577bcd7bc7..9ae972f918 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeAddOutboundShipping.yaml @@ -1,6 +1,6 @@ type: object description: The outbound shipping method's details. -x-schemaName: AdminPostExchangesShippingReqSchema +x-schemaName: AdminExchangeAddOutboundShipping required: - shipping_option_id properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeUpdateInboundShipping.yaml similarity index 90% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminExchangeUpdateInboundShipping.yaml index 4fa5f2d335..88ee9baa4c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeUpdateInboundShipping.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeUpdateOutboundShipping.yaml similarity index 90% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminExchangeUpdateOutboundShipping.yaml index 4fa5f2d335..babb49c32a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeUpdateOutboundShipping.yaml @@ -1,6 +1,6 @@ type: object description: The details of the shipping method to update. -x-schemaName: AdminPostExchangesShippingActionReqSchema +x-schemaName: AdminExchangeUpdateOutboundShipping properties: custom_amount: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentDeliveryAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentDeliveryAddress.yaml new file mode 100644 index 0000000000..2d62c924d6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentDeliveryAddress.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminIndexDetailsResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminIndexDetailsResponse.yaml new file mode 100644 index 0000000000..faad52aefc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminIndexDetailsResponse.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminIndexSyncPayload.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminIndexSyncPayload.yaml new file mode 100644 index 0000000000..9069022822 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminIndexSyncPayload.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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInitiateReceiveReturn.yaml similarity index 91% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminInitiateReceiveReturn.yaml index f4b1f18cb7..01e46855f3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInitiateReceiveReturn.yaml @@ -1,6 +1,6 @@ type: object description: The return receival details. -x-schemaName: AdminPostReceiveReturnsReqSchema +x-schemaName: AdminInitiateReceiveReturn properties: internal_note: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInitiateReturnRequest.yaml similarity index 95% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminInitiateReturnRequest.yaml index 137c180ca9..66c071b588 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInitiateReturnRequest.yaml @@ -1,6 +1,6 @@ type: object description: The return's details. -x-schemaName: AdminPostReturnsReqSchema +x-schemaName: AdminInitiateReturnRequest required: - order_id properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminMarkPaymentCollectionPaid.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminMarkPaymentCollectionAsPaid.yaml similarity index 81% rename from www/apps/api-reference/specs/store/components/schemas/AdminMarkPaymentCollectionPaid.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminMarkPaymentCollectionAsPaid.yaml index eec1356710..438d0ff1e6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminMarkPaymentCollectionPaid.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminMarkPaymentCollectionAsPaid.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml index dc257c3f04..d5ef04cbb6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml index 36005625f3..4d3dfde938 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml index a75e92bad2..d5f3755189 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml deleted file mode 100644 index 71c3bc5ac6..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml +++ /dev/null @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml index 6674fcc3e6..13ff822552 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -9,13 +9,13 @@ required: - length - title - status - - description - id - created_at - updated_at - subtitle - thumbnail - handle + - description - is_giftcard - width - weight diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml index 1238fdf516..fd0f306a55 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml index b6c4ca8752..8656985d38 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReceiveItems.yaml similarity index 93% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminReceiveItems.yaml index c3e219537a..be353cddf5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReceiveItems.yaml @@ -1,6 +1,6 @@ type: object description: The items details. -x-schemaName: AdminPostReturnsReceiveItemsReqSchema +x-schemaName: AdminReceiveItems properties: items: type: array diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePaymentRefund.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRefundPayment.yaml similarity index 89% rename from www/apps/api-reference/specs/admin/components/schemas/AdminCreatePaymentRefund.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminRefundPayment.yaml index b5be8ea589..7a3048985c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePaymentRefund.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRefundPayment.yaml @@ -13,4 +13,4 @@ properties: type: string title: note description: A note to attach to the refund. -x-schemaName: AdminCreatePaymentRefund +x-schemaName: AdminRefundPayment diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml index f8126c6286..abca8cce51 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTransferOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRequestOrderTransfer.yaml similarity index 93% rename from www/apps/api-reference/specs/admin/components/schemas/AdminTransferOrder.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminRequestOrderTransfer.yaml index 675e3606c1..0581b20df3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTransferOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRequestOrderTransfer.yaml @@ -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: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateClaimItem.yaml similarity index 88% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateClaimItem.yaml index 9ce243d228..966d490442 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateClaimItem.yaml @@ -1,6 +1,6 @@ type: object description: The details to update in the item. -x-schemaName: AdminPostClaimsItemsActionReqSchema +x-schemaName: AdminUpdateClaimItem properties: quantity: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateClaimOutboundItem.yaml similarity index 88% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateClaimOutboundItem.yaml index 9ce243d228..c49dee29a9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateClaimOutboundItem.yaml @@ -1,6 +1,6 @@ type: object description: The details to update in the item. -x-schemaName: AdminPostClaimsItemsActionReqSchema +x-schemaName: AdminUpdateClaimOutboundItem properties: quantity: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml index 8396b38deb..60e5ef43c3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateExchangeOutboundItem.yaml similarity index 84% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateExchangeOutboundItem.yaml index b751b43bd8..50f79741b6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateExchangeOutboundItem.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateFulfillmentSetServiceZone.yaml similarity index 99% rename from www/apps/api-reference/specs/admin/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateFulfillmentSetServiceZone.yaml index a319aa1491..6cd3cadfdd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateFulfillmentSetServiceZone.yaml @@ -155,4 +155,4 @@ properties: type: string title: id description: The ID of an existing geo zone. -x-schemaName: AdminUpdateFulfillmentSetServiceZones +x-schemaName: AdminUpdateFulfillmentSetServiceZone diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateInventoryLocationLevel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateInventoryLevel.yaml similarity index 87% rename from www/apps/api-reference/specs/admin/components/schemas/AdminUpdateInventoryLocationLevel.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateInventoryLevel.yaml index 94fba3e700..12752ace19 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateInventoryLocationLevel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateInventoryLevel.yaml @@ -9,4 +9,4 @@ properties: type: number title: incoming_quantity description: The inventory level's incoming quantity. -x-schemaName: AdminUpdateInventoryLocationLevel +x-schemaName: AdminUpdateInventoryLevel diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml index cd3ef369d9..99ef76b0ce 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePaymentRefundReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateRefundReason.yaml similarity index 71% rename from www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePaymentRefundReason.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateRefundReason.yaml index 132b0827dc..73a8147aca 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePaymentRefundReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateRefundReason.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnItems.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnItems.yaml new file mode 100644 index 0000000000..3f7ed31f4e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnItems.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnRequest.yaml similarity index 92% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnRequest.yaml index 638346da8c..e2b0f1a7d5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnRequest.yaml @@ -1,6 +1,6 @@ type: object description: The return's details. -x-schemaName: AdminPostReturnsReturnReqSchema +x-schemaName: AdminUpdateReturnRequest properties: location_id: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnShipping.yaml similarity index 90% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnShipping.yaml index 0ad7fb99be..a0d35d4ae1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnShipping.yaml @@ -1,6 +1,6 @@ type: object description: The shipping method's details. -x-schemaName: AdminPostReturnsShippingActionReqSchema +x-schemaName: AdminUpdateReturnShipping properties: custom_amount: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingOption.yaml new file mode 100644 index 0000000000..806201a2f1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingOption.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml index ed60861669..3747b05929 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml index 734283353b..53b1467a8b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStoreSupportedCurrency.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStoreSupportedCurrency.yaml new file mode 100644 index 0000000000..9f942d359d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStoreSupportedCurrency.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml index e79271cd68..004a02e39e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml index 74d80a6209..e23119a7a4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/IndexInfo.yaml b/www/apps/api-reference/specs/admin/components/schemas/IndexInfo.yaml new file mode 100644 index 0000000000..d9cafb36bd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/IndexInfo.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml index 2ff9e3c53a..138c171d78 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreDeclineOrderTransferRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreDeclineOrderTransfer.yaml similarity index 83% rename from www/apps/api-reference/specs/admin/components/schemas/StoreDeclineOrderTransferRequest.yaml rename to www/apps/api-reference/specs/admin/components/schemas/StoreDeclineOrderTransfer.yaml index ab03d7e6b8..128b50460c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreDeclineOrderTransferRequest.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreDeclineOrderTransfer.yaml @@ -1,6 +1,6 @@ type: object description: The details of declining the order transfer request. -x-schemaName: StoreDeclineOrderTransferRequest +x-schemaName: StoreDeclineOrderTransfer required: - token properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml index 2cedb499ba..2b757df371 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml index 5ee38cc877..2d800db80f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index aa80d843da..ac5d1acb97 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -149,6 +149,10 @@ tags: x-associatedSchema: $ref: '#/components/schemas/AdminGiftCard' + - 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 description: | An inventory item is a stock-kept product whose inventory is managed. @@ -2087,23 +2091,7 @@ paths: content: application/json: schema: - type: object - 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. + $ref: '#/components/schemas/AdminBatchLink' x-codeSamples: - lang: JavaScript label: JS SDK @@ -2206,6 +2194,55 @@ paths: type: boolean title: with_deleted 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: - api_token: [] - cookie_auth: [] @@ -2769,23 +2806,7 @@ paths: content: application/json: schema: - type: object - 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. + $ref: '#/components/schemas/AdminBatchLink' x-codeSamples: - lang: JavaScript label: JS SDK @@ -2882,11 +2903,11 @@ paths: description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - name: deleted_at in: query - description: The claim's deleted at. + description: Filter by the claim's deletion date. required: false schema: type: object - description: The claim's deleted at. + description: The claim's deletion date. properties: $and: type: array @@ -3154,20 +3175,20 @@ paths: oneOf: - type: string title: status - description: The claim's status. + description: Filter by the claim's status. - type: array - description: The claim's status. + description: Filter by the claim's status. items: type: string title: status - description: The status's details. + description: The claim's status. - name: created_at in: query - description: The claim's created at. + description: Filter by the claim's creation date. required: false schema: type: object - description: The claim's created at. + description: The claim's creation date. properties: $and: type: array @@ -3394,11 +3415,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The claim's updated at. + description: Filter by the claim's update date. required: false schema: type: object - description: The claim's updated at. + description: The claim's update date. properties: $and: type: array @@ -3715,6 +3736,391 @@ paths: description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' + - name: 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: - api_token: [] - cookie_auth: [] @@ -3723,7 +4129,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostOrderClaimsReqSchema' + $ref: '#/components/schemas/AdminCreateClaim' x-codeSamples: - lang: JavaScript label: JS SDK @@ -3950,7 +4356,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostClaimItemsReqSchema' + $ref: '#/components/schemas/AdminAddClaimItems' x-codeSamples: - lang: JavaScript label: JS SDK @@ -4044,7 +4450,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostClaimsItemsActionReqSchema' + $ref: '#/components/schemas/AdminUpdateClaimItem' x-codeSamples: - lang: JavaScript label: JS SDK @@ -4540,7 +4946,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostClaimsShippingActionReqSchema' + $ref: '#/components/schemas/AdminClaimUpdateInboundShipping' x-codeSamples: - lang: JavaScript label: JS SDK @@ -4699,7 +5105,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostClaimsAddItemsReqSchema' + $ref: '#/components/schemas/AdminAddClaimOutboundItems' x-codeSamples: - lang: JavaScript label: JS SDK @@ -4795,7 +5201,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostClaimsItemsActionReqSchema' + $ref: '#/components/schemas/AdminUpdateClaimOutboundItem' x-codeSamples: - lang: JavaScript label: JS SDK @@ -4964,7 +5370,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostClaimsShippingReqSchema' + $ref: '#/components/schemas/AdminClaimAddOutboundShipping' x-codeSamples: - lang: JavaScript label: JS SDK @@ -5062,7 +5468,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostClaimsShippingActionReqSchema' + $ref: '#/components/schemas/AdminClaimUpdateOutboundShipping' x-codeSamples: - lang: JavaScript label: JS SDK @@ -6610,23 +7016,7 @@ paths: content: application/json: schema: - type: object - description: The products to add or remove. - properties: - add: - type: array - description: The products to add to the collection. - items: - type: string - title: add - description: A product's ID. - remove: - type: array - description: The products to remove from the collection. - items: - type: string - title: remove - description: A product's ID. + $ref: '#/components/schemas/AdminBatchLink' x-codeSamples: - lang: JavaScript label: JS SDK @@ -8144,23 +8534,7 @@ paths: content: application/json: schema: - type: object - description: The customers to add or remove from the group. - properties: - add: - type: array - description: The customers to add to the group. - items: - type: string - title: add - description: A customer's ID. - remove: - type: array - description: The customers to remove from the group. - items: - type: string - title: remove - description: A customer's ID. + $ref: '#/components/schemas/AdminBatchLink' x-codeSamples: - lang: JavaScript label: JS SDK @@ -12873,23 +13247,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - properties: - add: - type: array - description: The customer groups to add the customer to. - items: - type: string - title: add - description: The ID of the group to add the customer to. - remove: - type: array - description: The customer groups to remove the customer from. - items: - type: string - title: remove - description: The ID of the group to remove the customer from. + $ref: '#/components/schemas/AdminBatchLink' x-codeSamples: - lang: JavaScript label: JS SDK @@ -15053,19 +15411,6 @@ paths: required: true schema: type: string - - name: fields - in: query - description: |- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields. - externalDocs: - url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15098,6 +15443,10 @@ paths: responses: '200': description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -15123,6 +15472,11 @@ paths: Emitted when an order is placed, or when a draft order is converted to an order. deprecated: false + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminDraftOrderParams' /admin/draft-orders/{id}/edit: post: operationId: PostDraftOrdersIdEdit @@ -17052,7 +17406,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostOrderExchangesReqSchema' + $ref: '#/components/schemas/AdminCreateExchange' x-codeSamples: - lang: JavaScript label: JS SDK @@ -17259,6 +17613,16 @@ paths: required: true schema: type: string + - name: fields + in: query + description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -17267,7 +17631,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema' + $ref: '#/components/schemas/AdminAddExchangeInboundItems' x-codeSamples: - lang: JavaScript label: JS SDK @@ -17592,7 +17956,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostExchangesShippingActionReqSchema' + $ref: '#/components/schemas/AdminExchangeUpdateInboundShipping' x-codeSamples: - lang: JavaScript label: JS SDK @@ -17749,7 +18113,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostExchangesAddItemsReqSchema' + $ref: '#/components/schemas/AdminAddExchangeOutboundItems' x-codeSamples: - lang: JavaScript label: JS SDK @@ -17842,7 +18206,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostExchangesItemsActionReqSchema' + $ref: '#/components/schemas/AdminUpdateExchangeOutboundItem' x-codeSamples: - lang: JavaScript label: JS SDK @@ -18010,7 +18374,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostExchangesShippingReqSchema' + $ref: '#/components/schemas/AdminExchangeAddOutboundShipping' x-codeSamples: - lang: JavaScript label: JS SDK @@ -18104,7 +18468,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostExchangesShippingActionReqSchema' + $ref: '#/components/schemas/AdminExchangeUpdateOutboundShipping' x-codeSamples: - lang: JavaScript label: JS SDK @@ -18725,7 +19089,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateFulfillmentSetServiceZones' + $ref: '#/components/schemas/AdminCreateFulfillmentSetServiceZone' x-codeSamples: - lang: JavaScript label: JS SDK @@ -18900,7 +19264,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminUpdateFulfillmentSetServiceZones' + $ref: '#/components/schemas/AdminUpdateFulfillmentSetServiceZone' x-codeSamples: - lang: JavaScript label: JS SDK @@ -19268,7 +19632,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateShipment' + $ref: '#/components/schemas/AdminCreateFulfillmentShipment' x-codeSamples: - lang: JavaScript label: JS SDK @@ -20032,6 +20396,91 @@ paths: - text: Cloud description: | This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin). + /admin/index/details: + get: + operationId: GetIndexDetails + summary: Get Index Details + description: Retrieve index metadata, including entity type, status, last synced key, and last updated timestamp. + x-authenticated: true + parameters: [] + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/index/details' \ + -H 'Authorization: Bearer {access_token}' + tags: + - Index + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminIndexDetailsResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-since: 2.11.2 + x-featureFlag: index + /admin/index/sync: + post: + operationId: PostIndexSync + summary: Trigger Index Sync + description: Trigger reindexing or re-ingestion of the Index Module. + x-authenticated: true + parameters: [] + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminIndexSyncPayload' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/index/sync' \ + -H 'Authorization: Bearer {access_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "strategy": "full" + }' + tags: + - Index + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-since: 2.11.2 + x-featureFlag: index /admin/inventory-items: get: operationId: GetInventoryItems @@ -20974,24 +21423,6 @@ paths: type: string title: order description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - - name: $and - in: query - 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 - required: false - schema: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - name: with_deleted in: query description: Whether to include deleted records in the result. @@ -21000,6 +21431,20 @@ paths: type: boolean title: with_deleted description: Whether to include deleted records in the result. + - name: location_id + in: query + required: false + schema: + oneOf: + - type: string + title: location_id + description: Filter by the inventory item's location ID. + - type: array + description: The inventory item's location IDs. + items: + type: string + title: location_id + description: The location ID. security: - api_token: [] - cookie_auth: [] @@ -21108,7 +21553,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateInventoryLocationLevel' + $ref: '#/components/schemas/AdminBatchCreateInventoryItemLocationLevels' x-codeSamples: - lang: Shell label: cURL @@ -21251,7 +21696,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminUpdateInventoryLocationLevel' + $ref: '#/components/schemas/AdminUpdateInventoryLevel' x-codeSamples: - lang: JavaScript label: JS SDK @@ -24147,34 +24592,6 @@ paths: description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' - - name: id - in: query - required: false - schema: - oneOf: - - type: string - title: id - description: The order's ID. - - type: array - description: The order's ID. - items: - type: string - title: id - description: The id's ID. - - name: status - in: query - required: false - schema: - oneOf: - - type: string - title: status - description: The order's status. - - type: array - description: The order's status. - items: - type: string - title: status - description: The status's details. - name: version in: query description: The order's version. @@ -24183,18 +24600,6 @@ paths: type: number title: version description: The order's version. - - name: created_at - in: query - required: false - schema: {} - - name: updated_at - in: query - required: false - schema: {} - - name: deleted_at - in: query - required: false - schema: {} security: - api_token: [] - cookie_auth: [] @@ -24270,6 +24675,14 @@ paths: description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' + - name: version + in: query + description: The version of the order to retrieve. + required: false + schema: + type: number + title: version + description: The version of the order to retrieve. security: - api_token: [] - cookie_auth: [] @@ -24530,7 +24943,7 @@ paths: description: | Retrieve a list of changes made on an order, including returns, exchanges, etc... - The changes can be filtered by fields like FILTER FIELDS. The changes can also be paginated. + The changes can be filtered by fields like `created_at`. The changes can also be paginated. x-authenticated: true parameters: - name: id @@ -24553,6 +24966,806 @@ paths: 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. + - name: created_at + in: query + description: Filter by the order change's creation date. + required: false + schema: + type: object + description: Filter by the order change's creation date. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the values of this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: updated_at + in: query + description: Filter by the order change's update date. + required: false + schema: + type: object + description: Filter by the order change's update date. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the values of this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: deleted_at + in: query + description: Filter by the order change's deletion date. + required: false + schema: + type: object + description: Filter by the order change'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 multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the values of this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by an order change ID. + - type: array + description: Filter by order change IDs. + items: + type: string + title: id + description: An order change ID. + - type: object + description: The order's ID. + 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 + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: Filter by the order change's status. + - type: array + description: Filter by multiple order change statuses. + items: + type: string + title: status + description: An order change status. + - type: object + description: The order change's status. + 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 + - name: change_type + in: query + required: false + schema: + oneOf: + - type: string + title: change_type + description: Filter by the order change's type. + - type: array + description: Filter by multiple order change types. + items: + type: string + title: change_type + description: An order change type. + - type: object + description: Filter the order change's type. + 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 + - 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: - api_token: [] - cookie_auth: [] @@ -24732,7 +25945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateOrderCreditLines' + $ref: '#/components/schemas/AdminCreateOrderCreditLine' x-codeSamples: - lang: JavaScript label: JS SDK @@ -24962,16 +26175,6 @@ paths: required: true schema: type: string - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - externalDocs: - url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -25396,36 +26599,6 @@ paths: type: number title: version description: The version's details. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - externalDocs: - url: '#pagination' - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - externalDocs: - url: '#pagination' - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - externalDocs: - url: '#pagination' security: - api_token: [] - cookie_auth: [] @@ -25653,7 +26826,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminTransferOrder' + $ref: '#/components/schemas/AdminRequestOrderTransfer' x-codeSamples: - lang: JavaScript label: JS SDK @@ -25969,7 +27142,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminMarkPaymentCollectionPaid' + $ref: '#/components/schemas/AdminMarkPaymentCollectionAsPaid' x-codeSamples: - lang: JavaScript label: JS SDK @@ -26844,7 +28017,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreatePaymentCapture' + $ref: '#/components/schemas/AdminCapturePayment' x-codeSamples: - lang: JavaScript label: JS SDK @@ -26931,7 +28104,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreatePaymentRefund' + $ref: '#/components/schemas/AdminRefundPayment' x-codeSamples: - lang: JavaScript label: JS SDK @@ -27462,6 +28635,348 @@ paths: description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' + - name: q + in: query + description: Apply a search query to the price list's searchable properties. + required: false + schema: + type: string + title: q + description: Apply a search query to the price list's searchable properties. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by a specific price list ID. + - type: array + description: Filter by multiple price list IDs. + items: + type: string + title: id + description: A price list ID. + - name: starts_at + in: query + description: Filter by a price list's start date. + required: false + schema: + type: object + description: Filter by a price list's start 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: ends_at + in: query + description: Filter by a price list's end date. + required: false + schema: + type: object + description: Filter by a price list's end 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: status + in: query + description: Filter by price list statuses. + required: false + schema: + type: array + description: Filter by price list statuses. + items: + type: string + description: A price list status. + enum: + - draft + - active + - name: rules_count + in: query + description: Filter by multiple price list rules count. + required: false + schema: + type: array + description: Filter by price list rules count. + items: + type: number + title: rules_count + description: A price list's rules count. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + externalDocs: + url: '#pagination' + - name: with_deleted + in: query + description: The price list's with deleted. + required: false + schema: + type: boolean + title: with_deleted + description: The price list's with deleted. + - 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: - api_token: [] - cookie_auth: [] @@ -29064,44 +30579,22 @@ paths: 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. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. externalDocs: url: '#select-fields-and-relations' - - name: offset + - name: include_ancestors_tree in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - externalDocs: - url: '#pagination' - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - externalDocs: - url: '#pagination' - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - externalDocs: - url: '#pagination' - - name: with_deleted - in: query - description: Whether to include deleted records in the result. + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. required: false schema: type: boolean - title: with_deleted - description: Whether to include deleted records in the result. + title: include_ancestors_tree + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + - name: include_descendants_tree + in: query + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + required: false + schema: + type: boolean + title: include_descendants_tree + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. security: - api_token: [] - cookie_auth: [] @@ -29213,6 +30706,851 @@ paths: type: boolean title: include_descendants_tree description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + - name: is_internal + in: query + description: Filter by whether the product category is internal. + required: false + schema: + type: boolean + title: is_internal + description: Filter by whether the product category is internal. + - name: is_active + in: query + description: Filter by whether the product category is active. + required: false + schema: + type: boolean + title: is_active + description: Filter by whether the product category is active. + - name: q + in: query + description: Apply a search query to the product category's searchable properties. + required: false + schema: + type: string + title: q + description: Apply a search query to the product category's searchable properties. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by the product category's ID. + - type: array + description: Filter by product category IDs. + items: + type: string + title: id + description: A product category ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: Filter by the product category's name. + - type: array + description: Filter by product category names. + items: + type: string + title: name + description: A product category name. + - name: description + in: query + required: false + schema: + oneOf: + - type: string + title: description + description: Filter by the product category's description. + - type: array + description: Filter by product category descriptions. + items: + type: string + title: description + description: A product category description. + - name: parent_category_id + in: query + required: false + schema: + oneOf: + - type: string + title: parent_category_id + description: Retrieve the categories of a given parent category's ID. + - type: array + description: Retrieve the categories of the given parent category IDs. + items: + type: string + title: parent_category_id + description: A parent category ID. + - name: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: Filter by the product category's handle. + - type: array + description: Filter by product category handles. + items: + type: string + title: handle + description: A product category handle. + - name: created_at + in: query + description: Filter by the category's creation date. + required: false + schema: + type: object + description: Filter by the category's creation date. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the values of this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: updated_at + in: query + description: Filter by the category's update date. + required: false + schema: + type: object + description: Filter by the category's update date. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the values of this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: deleted_at + in: query + description: Filter by the category's deletion date. + required: false + schema: + type: object + description: Filter by the category'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 multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the values of this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + externalDocs: + url: '#pagination' + - name: with_deleted + in: query + description: The product category's with deleted. + required: false + schema: + type: boolean + title: with_deleted + description: The product category's with deleted. + - 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: - api_token: [] - cookie_auth: [] @@ -29283,6 +31621,22 @@ paths: 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. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. externalDocs: url: '#select-fields-and-relations' + - name: include_ancestors_tree + in: query + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + required: false + schema: + type: boolean + title: include_ancestors_tree + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + - name: include_descendants_tree + in: query + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + required: false + schema: + type: boolean + title: include_descendants_tree + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. security: - api_token: [] - cookie_auth: [] @@ -29449,6 +31803,22 @@ paths: 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. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. externalDocs: url: '#select-fields-and-relations' + - name: include_ancestors_tree + in: query + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + required: false + schema: + type: boolean + title: include_ancestors_tree + description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + - name: include_descendants_tree + in: query + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + required: false + schema: + type: boolean + title: include_descendants_tree + description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. security: - api_token: [] - cookie_auth: [] @@ -29457,23 +31827,7 @@ paths: content: application/json: schema: - type: object - description: The products to add or remove from the category. - properties: - add: - type: array - description: The products to add. - items: - type: string - title: add - description: A product ID. - remove: - type: array - description: The product to remove. - items: - type: string - title: remove - description: A product ID. + $ref: '#/components/schemas/AdminBatchLink' x-codeSamples: - lang: JavaScript label: JS SDK @@ -32500,7 +34854,7 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). updated_at: type: object - description: The variant's updated at. + description: Filter by the variant's update date. properties: $and: type: array @@ -32760,35 +35114,47 @@ paths: oneOf: - type: string title: ean - description: The variant's ean. + description: Filter by a variant's ean. - type: array - description: The variant's ean. + description: Filter by variant eans. items: type: string title: ean - description: The ean's details. + description: A variant's ean. upc: oneOf: - type: string title: upc - description: The variant's upc. + description: Filter by a variant's upc. - type: array - description: The variant's upc. + description: Filter by variant upcs. items: type: string title: upc - description: The upc's details. + description: A variant's upc. barcode: oneOf: - type: string title: barcode - description: The variant's barcode. + description: Filter by a variant's barcode. - type: array - description: The variant's barcode. + description: Filter by variant barcodes. items: type: string title: barcode - description: The barcode's details. + description: A variant's barcode. + with_deleted: + type: boolean + title: with_deleted + description: Whether to include deleted variants. + - name: with_deleted + in: query + description: Whether to include deleted products. + required: false + schema: + type: boolean + title: with_deleted + description: Whether to include deleted products. security: - api_token: [] - cookie_auth: [] @@ -33147,6 +35513,610 @@ paths: description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' + - name: tags + in: query + description: Filter products by their tags. + required: false + schema: + type: object + description: Filter products by their tags. + properties: + id: + type: array + description: Filter by tag IDs. + items: + type: string + title: id + description: A tag ID. + - name: variants + in: query + description: Filter the products' variants. + required: false + schema: + type: object + description: Filter the products' variants. + properties: + options: + type: object + description: Filter the variants by their options. + properties: + value: + type: string + title: value + description: The option's value. + option_id: + type: string + title: option_id + description: The option's ID. + option: + type: object + description: The option's details. + - name: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: Filter products by their title. + - type: array + description: Filter products by multiple titles. + items: + type: string + title: title + description: A product title. + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: Filter products by their status. + enum: + - draft + - proposed + - published + - rejected + - type: array + description: Filter products by multiple statuses. + items: + type: string + description: A product status. + enum: + - draft + - proposed + - published + - rejected + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter products by their ID. + - type: array + description: Filter products by multiple IDs. + items: + type: string + title: id + description: A product ID. + - name: sales_channel_id + in: query + required: false + schema: + oneOf: + - type: string + title: sales_channel_id + description: Filter products by their sales channel ID. + - type: array + description: Filter products by multiple sales channel IDs. + items: + type: string + title: sales_channel_id + description: A sales channel ID. + - name: created_at + in: query + description: Filter by a product's creation date. + required: false + schema: + type: object + description: Filter by a product'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 product's update date. + required: false + schema: + type: object + description: Filter by a product'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: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: Filter products by their handle. + - type: array + description: Filter products by multiple handles. + items: + type: string + title: handle + description: A product handle. + - name: is_giftcard + in: query + description: Filter products by whether they are gift cards. + required: false + schema: + type: boolean + title: is_giftcard + description: Whether the product is a gift card. + - name: collection_id + in: query + required: false + schema: + oneOf: + - type: string + title: collection_id + description: Filter products by their collection ID. + - type: array + description: Filter products by multiple collection IDs. + items: + type: string + title: collection_id + description: A collection ID. + - name: type_id + in: query + required: false + schema: + oneOf: + - type: string + title: type_id + description: Filter products by their type ID. + - type: array + description: Filter products by multiple type IDs. + items: + type: string + title: type_id + description: The type ID's details. + - name: deleted_at + in: query + description: Filter by a product's deletion date. + required: false + schema: + type: object + description: Filter by a product'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`). + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + externalDocs: + url: '#pagination' + - name: q + in: query + description: The product's q. + required: false + schema: + type: string + title: q + description: The product's q. + - name: category_id + in: query + required: false + schema: + oneOf: + - type: string + title: category_id + description: Filter products by their category ID. + - type: array + description: Filter products by their category IDs. + items: + type: string + title: category_id + description: A category ID. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' + - name: with_deleted + in: query + description: The product's with deleted. + required: false + schema: + type: boolean + title: with_deleted + description: The product's with deleted. + - name: $and + in: query + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + - name: $or + in: query + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + - name: price_list_id + in: query + required: false + schema: + oneOf: + - type: string + title: price_list_id + description: Filter products by the ID of a price list they belong to. + - type: array + description: Filter products by the IDs of price lists they belong to. + items: + type: string + title: price_list_id + description: A price list ID. security: - api_token: [] - cookie_auth: [] @@ -33725,6 +36695,89 @@ paths: ``` description: Emitted when products are deleted. deprecated: false + /admin/products/{id}/images/{image_id}/variants/batch: + post: + operationId: PostProductsIdImagesImage_idVariantsBatch + summary: Manage Variants of Product Image + description: Manage the association between product variants and a product image. You can add or remove associations between variants and the image. + x-authenticated: true + parameters: + - name: id + in: path + description: The product's ID. + required: true + schema: + type: string + - name: image_id + in: path + description: The product image's ID. + required: true + schema: + type: string + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminBatchImageVariantRequest' + x-codeSamples: + - lang: JavaScript + label: JS SDK + source: |- + 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) + }) + - lang: Shell + label: cURL + source: |- + 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"] + }' + tags: + - Products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminBatchImageVariantResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: batchImageVariantsWorkflow + x-events: [] + x-since: 2.11.2 /admin/products/{id}/options: get: operationId: GetProductsIdOptions @@ -35166,8 +38219,8 @@ paths: description: The associations to create between a product variant and an inventory item. required: - variant_id - - inventory_item_id - required_quantity + - inventory_item_id properties: required_quantity: type: number @@ -35189,8 +38242,8 @@ paths: description: Update a product variant's association with an inventory item. required: - variant_id - - inventory_item_id - required_quantity + - inventory_item_id properties: required_quantity: type: number @@ -35568,6 +38621,89 @@ paths: ``` description: Emitted when product variants are deleted. deprecated: false + /admin/products/{id}/variants/{variant_id}/images/batch: + post: + operationId: PostProductsIdVariantsVariant_idImagesBatch + summary: Manage Images of Product Variant + description: Manage the association between product images and a product variant. You can add or remove associations between images and the variant. + x-authenticated: true + parameters: + - name: id + in: path + description: The product's ID. + required: true + schema: + type: string + - name: variant_id + in: path + description: The product variant's ID. + required: true + schema: + type: string + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminBatchVariantImagesRequest' + x-codeSamples: + - lang: JavaScript + label: JS SDK + source: |- + 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) + }) + - lang: Shell + label: cURL + source: |- + 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"] + }' + tags: + - Products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminBatchVariantImagesResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: batchVariantImagesWorkflow + x-events: [] + x-since: 2.11.2 /admin/products/{id}/variants/{variant_id}/inventory-items: post: operationId: PostProductsIdVariantsVariant_idInventoryItems @@ -37049,28 +40185,6 @@ paths: type: string title: order description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - - name: promotion_type - in: query - description: The promotion type to retrieve rules for. - required: false - schema: - type: string - title: promotion_type - description: The promotion type to retrieve rules for. - enum: - - standard - - buyget - - name: application_method_type - in: query - description: The application method type to retrieve rules for. - required: false - schema: - type: string - title: application_method_type - description: The application method type to retrieve rules for. - enum: - - fixed - - percentage - name: with_deleted in: query description: Whether to include deleted records in the result. @@ -37085,8 +40199,39 @@ paths: required: false schema: type: string - title: application_method_target_type description: The application method target type to retrieve rules for. + - name: q + in: query + description: Apply a search query on the rule values' searchable properties. + required: false + schema: + type: string + title: q + description: Apply a search query on the rule values' searchable properties. + - name: value + in: query + required: false + schema: + oneOf: + - type: string + title: value + description: Filter by a specific rule value. + - type: array + description: Filter by multiple rule values. + items: + type: string + title: value + description: A rule value. + - name: fields + in: query + description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -37504,16 +40649,37 @@ paths: required: true schema: type: string - - name: fields + - name: promotion_type in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. + description: The promotion's type. required: false schema: type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - externalDocs: - url: '#select-fields-and-relations' + description: The promotion's type. + enum: + - standard + - buyget + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + description: The promotion's application method type. + enum: + - fixed + - percentage + - name: application_method_target_type + in: query + description: The promotion's application method target type. + required: false + schema: + type: string + description: The promotion's application method target type. + enum: + - items + - shipping_methods + - order security: - api_token: [] - cookie_auth: [] @@ -37625,16 +40791,37 @@ paths: required: true schema: type: string - - name: fields + - name: promotion_type in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. + description: The promotion's type. required: false schema: type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - externalDocs: - url: '#select-fields-and-relations' + description: The promotion's type. + enum: + - standard + - buyget + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + description: The promotion's application method type. + enum: + - fixed + - percentage + - name: application_method_target_type + in: query + description: The promotion's application method target type. + required: false + schema: + type: string + description: The promotion's application method target type. + enum: + - items + - shipping_methods + - order security: - api_token: [] - cookie_auth: [] @@ -37746,16 +40933,37 @@ paths: required: true schema: type: string - - name: fields + - name: promotion_type in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. + description: The promotion's type. required: false schema: type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - externalDocs: - url: '#select-fields-and-relations' + description: The promotion's type. + enum: + - standard + - buyget + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + description: The promotion's application method type. + enum: + - fixed + - percentage + - name: application_method_target_type + in: query + description: The promotion's application method target type. + required: false + schema: + type: string + description: The promotion's application method target type. + enum: + - items + - shipping_methods + - order security: - api_token: [] - cookie_auth: [] @@ -37891,6 +41099,37 @@ paths: description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' + - name: promotion_type + in: query + description: The type + required: false + schema: + type: string + description: The promotion's type. + enum: + - standard + - buyget + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + description: The promotion's application method type. + enum: + - fixed + - percentage + - name: application_method_target_type + in: query + description: The promotion's application method target type. + required: false + schema: + type: string + description: The promotion's application method target type. + enum: + - items + - shipping_methods + - order security: - api_token: [] - cookie_auth: [] @@ -38301,7 +41540,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminUpdatePaymentRefundReason' + $ref: '#/components/schemas/AdminUpdateRefundReason' x-codeSamples: - lang: JavaScript label: JS SDK @@ -39833,20 +43072,133 @@ paths: type: boolean title: with_deleted description: Whether to include deleted records in the result. - - name: order_id + - name: q in: query + description: Apply a search query on the reservation's searchable properties. required: false schema: - oneOf: - - type: string - title: order_id - description: Filter by an order's ID to retrieve its associated reservations. - - type: array - description: Filter by multiple order IDs to retrieve their associated reservations. + type: string + title: q + description: Apply a search query on the reservation's searchable properties. + - name: quantity + in: query + description: Filter by the reservation's quantity. + required: false + schema: + type: object + description: Filter by a reservation's quantity. + 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: order_id - description: An order's ID. + 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: - api_token: [] - cookie_auth: [] @@ -41804,7 +45156,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReturnsReqSchema' + $ref: '#/components/schemas/AdminInitiateReturnRequest' x-codeSamples: - lang: JavaScript label: JS SDK @@ -41972,7 +45324,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReturnsReturnReqSchema' + $ref: '#/components/schemas/AdminUpdateReturnRequest' x-codeSamples: - lang: JavaScript label: JS SDK @@ -42125,7 +45477,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReturnsReceiveItemsReqSchema' + $ref: '#/components/schemas/AdminDismissItems' x-codeSamples: - lang: JavaScript label: JS SDK @@ -42379,7 +45731,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReceiveReturnsReqSchema' + $ref: '#/components/schemas/AdminInitiateReceiveReturn' x-codeSamples: - lang: JavaScript label: JS SDK @@ -42554,7 +45906,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReturnsReceiveItemsReqSchema' + $ref: '#/components/schemas/AdminReceiveItems' x-codeSamples: - lang: JavaScript label: JS SDK @@ -42809,7 +46161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReturnsConfirmRequestReqSchema' + $ref: '#/components/schemas/AdminConfirmReceiveReturn' x-codeSamples: - lang: JavaScript label: JS SDK @@ -42900,7 +46252,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReturnsConfirmRequestReqSchema' + $ref: '#/components/schemas/AdminConfirmReturnRequest' x-codeSamples: - lang: JavaScript label: JS SDK @@ -43072,7 +46424,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReturnsRequestItemsReqSchema' + $ref: '#/components/schemas/AdminAddReturnItems' x-codeSamples: - lang: JavaScript label: JS SDK @@ -43163,7 +46515,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReturnsRequestItemsActionReqSchema' + $ref: '#/components/schemas/AdminUpdateReturnItems' x-codeSamples: - lang: JavaScript label: JS SDK @@ -43326,7 +46678,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReturnsShippingReqSchema' + $ref: '#/components/schemas/AdminAddReturnShipping' x-codeSamples: - lang: JavaScript label: JS SDK @@ -43420,7 +46772,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostReturnsShippingActionReqSchema' + $ref: '#/components/schemas/AdminUpdateReturnShipping' x-codeSamples: - lang: JavaScript label: JS SDK @@ -44494,23 +47846,7 @@ paths: content: application/json: schema: - type: object - description: The products to add or remove from the channel. - properties: - add: - type: array - description: The products to add to the sales channel. - items: - type: string - title: add - description: A product's ID. - remove: - type: array - description: The products to remove from the sales channel. - items: - type: string - title: remove - description: A product's ID. + $ref: '#/components/schemas/AdminBatchLink' x-codeSamples: - lang: JavaScript label: JS SDK @@ -46220,7 +49556,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminUpdateShippingOptionType' + $ref: '#/components/schemas/AdminUpdateShippingOption' x-codeSamples: - lang: JavaScript label: JS SDK @@ -48178,23 +51514,7 @@ paths: content: application/json: schema: - type: object - description: The fulfillment providers to add or remove from the stock location. - properties: - add: - type: array - description: The fulfillment providers to add to the stock location. - items: - type: string - title: add - description: A fulfillment provider's ID. - remove: - type: array - description: The fulfillment providers to remove from the stock location. - items: - type: string - title: remove - description: A fulfillment provider's ID. + $ref: '#/components/schemas/AdminBatchLink' x-codeSamples: - lang: JavaScript label: JS SDK @@ -48363,23 +51683,7 @@ paths: content: application/json: schema: - type: object - description: The sales channels to add or remove. - properties: - add: - type: array - description: The sales channels to add. - items: - type: string - title: add - description: A sales channel's ID. - remove: - type: array - description: The sales channels to remove. - items: - type: string - title: remove - description: A sales channel's ID. + $ref: '#/components/schemas/AdminBatchLink' x-codeSamples: - lang: JavaScript label: JS SDK @@ -52448,30 +55752,6 @@ paths: description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' - - name: province_code - in: query - description: Filter by a tax region's province code. - required: false - schema: - type: string - title: province_code - description: Filter by a tax region's province code. - - name: provider_id - in: query - description: Filter by a tax provider ID to retrieve the tax regions using it. - required: false - schema: - type: string - title: provider_id - description: Filter by a tax provider ID to retrieve the tax regions using it. - - name: metadata - in: query - description: Filter by a tax region's metadata. Refer to the [Object Query Parameter](https://docs.medusajs.com/api/admin#object) section to learn how to filter by object fields. - required: false - schema: - type: object - description: Filter by a tax region's metadata. Refer to the [Object Query Parameter](https://docs.medusajs.com/api/admin#object) section to learn how to filter by object fields. - title: metadata security: - api_token: [] - cookie_auth: [] @@ -56276,6 +59556,84 @@ paths: $ref: '#/components/responses/500_error' components: schemas: + AdminAddClaimItems: + type: object + description: The details of the order items to add to the claim. + x-schemaName: AdminAddClaimItems + properties: + items: + type: array + description: The item's details. + items: + type: object + description: An item's details. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The ID of the order's item. + quantity: + type: number + title: quantity + description: The quantity of the order's item to add to the claim. + reason: + type: string + description: The reason the item is claimed. + enum: + - missing_item + - wrong_item + - production_failure + - other + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: A note that's only viewed by admin users. + AdminAddClaimOutboundItems: + 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. AdminAddDraftOrderItems: type: object description: The details of the items to add to a draft order. @@ -56367,6 +59725,163 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata + AdminAddExchangeInboundItems: + type: object + description: The details of the inbound (return) items. + x-schemaName: AdminAddExchangeInboundItems + properties: + items: + type: array + description: The details of the inbound (return) items. + items: + type: object + description: An item's details. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The ID of the order's item. + 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. + reason_id: + type: string + title: reason_id + description: The ID of the return reason to associate with the item. + 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 + location_id: + type: string + title: location_id + description: The ID of the location to which outbound items are sent from. + AdminAddExchangeOutboundItems: + type: object + description: The details of outbound items. + x-schemaName: AdminAddExchangeOutboundItems + properties: + items: + type: array + description: The details of outbound items. + 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 item's quantity. + 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. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether the item can be added even if it's not in stock. + 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 + AdminAddReturnItem: + 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 + AdminAddReturnItems: + type: object + description: The items' details. + x-schemaName: AdminAddReturnItems + properties: + items: + type: array + description: The items' details. + items: + $ref: '#/components/schemas/AdminAddReturnItem' + required: + - items + AdminAddReturnShipping: + 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 AdminApiKey: type: object description: The API key's details. @@ -56513,6 +60028,25 @@ components: type: number title: apply_to_quantity description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `1`. + AdminBatchCreateInventoryItemLocationLevels: + type: object + description: The inventory level's details. + required: + - location_id + properties: + location_id: + type: string + title: location_id + description: The ID of the associated location. + stocked_quantity: + type: number + title: stocked_quantity + description: The inventory level's stocked quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The inventory level's incoming quantity. + x-schemaName: AdminBatchCreateInventoryItemLocationLevels AdminBatchCreateInventoryItemsLocationLevels: type: object description: The details of an inventory level to create. @@ -56537,6 +60071,47 @@ components: title: incoming_quantity description: The incoming quantity to be added to stock. x-schemaName: AdminBatchCreateInventoryItemsLocationLevels + AdminBatchImageVariantRequest: + 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. + AdminBatchImageVariantResponse: + 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. AdminBatchInventoryItemLocationsLevel: type: object description: The inventory levels to create, update, or delete. @@ -56651,6 +60226,25 @@ components: type: string title: deleted description: The ID of a deleted inventory level. + AdminBatchLink: + 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 AdminBatchProductRequest: type: object description: The products to create, update, or delete. @@ -56847,6 +60441,10 @@ components: type: string title: url description: The image's URL. + id: + type: string + title: id + description: The image's ID. thumbnail: type: string title: thumbnail @@ -57061,8 +60659,53 @@ components: type: string title: id description: The update's ID. + thumbnail: + type: string + title: thumbnail + description: The variant's thumbnail. required: - id + AdminBatchVariantImagesRequest: + 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. + AdminBatchVariantImagesResponse: + 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. AdminCampaign: type: object description: The campaign's details. @@ -57173,6 +60816,15 @@ components: properties: campaign: $ref: '#/components/schemas/AdminCampaign' + AdminCapturePayment: + type: object + description: The payment's details. + properties: + amount: + type: number + title: amount + description: The amount to capture. + x-schemaName: AdminCapturePayment AdminClaim: type: object description: The claim's details. @@ -57282,6 +60934,35 @@ components: format: date-time title: deleted_at description: The date the claim was deleted. + AdminClaimAddOutboundShipping: + type: object + description: The details of the shipping method used to ship outbound items. + x-schemaName: AdminClaimAddOutboundShipping + 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 a custom price for the shipping method. + description: + type: string + title: description + description: The shipping method's description. + 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 AdminClaimDeleteResponse: type: object description: The details of the deleted claim. @@ -57396,6 +61077,44 @@ components: $ref: '#/components/schemas/AdminOrderPreview' return: $ref: '#/components/schemas/AdminReturn' + AdminClaimUpdateInboundShipping: + type: object + description: The details to update in the shipping method. + x-schemaName: AdminClaimUpdateInboundShipping + 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 + AdminClaimUpdateOutboundShipping: + 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 AdminCollection: type: object description: The product collection's details. @@ -57625,6 +61344,24 @@ components: - timestamp - metric - relationship + AdminConfirmReceiveReturn: + type: object + description: The confirmation's details. + x-schemaName: AdminConfirmReceiveReturn + properties: + no_notification: + type: boolean + title: no_notification + description: Whether to send the customer a notification about the confirmation. + AdminConfirmReturnRequest: + 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. AdminCreateApiKey: type: object description: The API key's details. @@ -57696,6 +61433,42 @@ components: metadata: type: object description: The shipping option's metadata, can hold custom key-value pairs. + AdminCreateClaim: + type: object + description: The claim's details. + x-schemaName: AdminCreateClaim + required: + - type + - order_id + properties: + type: + type: string + description: The claim's type. + enum: + - refund + - replace + order_id: + type: string + title: order_id + description: The ID of the order the claim is created for. + description: + type: string + title: description + description: The claim's description. + 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 AdminCreateCustomerGroup: type: object description: The customer group's details. @@ -57713,6 +61486,31 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata + AdminCreateExchange: + type: object + description: The exchange's details. + x-schemaName: AdminCreateExchange + required: + - order_id + properties: + order_id: + type: string + title: order_id + description: The ID of the order this exchange is created for. + description: + type: string + title: description + description: The exchange'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 AdminCreateFlatRateShippingOption: type: object description: The flat rate shipping option's details. @@ -57865,14 +61663,12 @@ components: 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 @@ -57883,118 +61679,17 @@ components: 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: '#/components/schemas/AdminFulfillmentDeliveryAddress' 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: '#/components/schemas/AdminCreateFulfillmentItem' 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: '#/components/schemas/AdminCreateFulfillmentLabel' order_id: type: string title: order_id @@ -58035,11 +61730,67 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminCreateFulfillmentSetServiceZones: + AdminCreateFulfillmentItem: type: object - description: The service zone's details. + 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 + AdminCreateFulfillmentLabel: + 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 + AdminCreateFulfillmentSetServiceZone: + type: object + description: Details of the service zone to create for the fulfillment set. required: - name + - geo_zones properties: name: type: string @@ -58179,7 +61930,19 @@ components: postal_expression: type: object description: The geo zone's postal expression or ZIP code. - x-schemaName: AdminCreateFulfillmentSetServiceZones + x-schemaName: AdminCreateFulfillmentSetServiceZone + AdminCreateFulfillmentShipment: + 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: '#/components/schemas/AdminCreateFulfillmentLabel' AdminCreateGiftCardParams: type: object description: The details of the gift card to create. @@ -58298,29 +62061,10 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminCreateInventoryLocationLevel: - type: object - description: The inventory level's details. - required: - - location_id - properties: - location_id: - type: string - title: location_id - description: The ID of the associated location. - stocked_quantity: - type: number - title: stocked_quantity - description: The inventory level's stocked quantity. - incoming_quantity: - type: number - title: incoming_quantity - description: The inventory level's incoming quantity. - x-schemaName: AdminCreateInventoryLocationLevel - AdminCreateOrderCreditLines: + AdminCreateOrderCreditLine: type: object description: The details of a credit line to add to an order. - x-schemaName: AdminCreateOrderCreditLines + x-schemaName: AdminCreateOrderCreditLine required: - amount - reference @@ -58347,15 +62091,6 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminCreatePaymentCapture: - type: object - description: The payment's details. - properties: - amount: - type: number - title: amount - description: The amount to capture. - x-schemaName: AdminCreatePaymentCapture AdminCreatePaymentCollection: type: object description: The payment collection's details. @@ -58372,23 +62107,6 @@ components: title: amount description: The amount to be paid. x-schemaName: AdminCreatePaymentCollection - AdminCreatePaymentRefund: - type: object - description: The refund's details. - properties: - amount: - type: number - title: amount - description: The amount to refund. - refund_reason_id: - type: string - title: refund_reason_id - description: The ID of a refund reason. - note: - type: string - title: note - description: A note to attach to the refund. - x-schemaName: AdminCreatePaymentRefund AdminCreatePriceList: type: object description: The price list's details. @@ -58436,38 +62154,41 @@ components: 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: '#/components/schemas/AdminCreatePriceListPrice' + AdminCreatePriceListPrice: + 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 AdminCreatePricePreference: type: object description: The price preference's details. @@ -59087,36 +62808,6 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminCreateShipment: - 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. AdminCreateShippingOptionRule: type: object description: The details of the shipping option rule. @@ -59225,8 +62916,8 @@ components: type: object description: The fulfillment set to create. required: - - type - name + - type properties: name: type: string @@ -59397,8 +63088,8 @@ components: 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 @@ -60442,6 +64133,33 @@ components: type: boolean title: deleted description: Whether the object was deleted. + AdminDismissItems: + 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. AdminDraftOrder: type: object description: The draft order's details. @@ -60451,13 +64169,13 @@ components: - items - shipping_methods - status - - currency_code - id - version - region_id - customer_id - sales_channel_id - email + - currency_code - payment_status - fulfillment_status - summary @@ -60743,6 +64461,15 @@ components: title: estimate_count description: The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate. x-featureFlag: index_engine + AdminDraftOrderParams: + 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. AdminDraftOrderPreview: type: object description: The draft order preview's details. @@ -60751,13 +64478,13 @@ components: - 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 @@ -61517,6 +65244,35 @@ components: type: boolean title: allow_backorder description: Whether variants that are out-of-stock can still be added as additional or outbound items. + AdminExchangeAddOutboundShipping: + type: object + description: The outbound shipping method's details. + x-schemaName: AdminExchangeAddOutboundShipping + 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 a custom amount for 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 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 AdminExchangeDeleteResponse: type: object description: The details of deleting an exchange. @@ -61599,6 +65355,44 @@ components: $ref: '#/components/schemas/AdminOrderPreview' return: $ref: '#/components/schemas/AdminReturn' + AdminExchangeUpdateInboundShipping: + type: object + description: The details of the shipping method to update. + x-schemaName: AdminExchangeUpdateInboundShipping + 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 + AdminExchangeUpdateOutboundShipping: + 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 AdminExportProductResponse: type: object description: The details of the product export. @@ -61837,6 +65631,61 @@ components: format: date-time title: deleted_at description: The date the address was deleted. + AdminFulfillmentDeliveryAddress: + 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 AdminFulfillmentItem: type: object description: The details of a fulfillment's item. @@ -62387,6 +66236,83 @@ components: title: mime_type description: The file's mime type. example: text/csv + AdminIndexDetailsResponse: + type: object + description: The index's metadata details. + x-schemaName: AdminIndexDetailsResponse + required: + - metadata + properties: + metadata: + type: array + description: The index's metadata. + items: + $ref: '#/components/schemas/IndexInfo' + AdminIndexSyncPayload: + 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 + AdminInitiateReceiveReturn: + type: object + description: The return receival details. + x-schemaName: AdminInitiateReceiveReturn + properties: + internal_note: + type: string + title: internal_note + description: A note viewed only by admin users. + description: + type: string + title: description + description: The return's description. + metadata: + type: object + description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata + AdminInitiateReturnRequest: + type: object + description: The return's details. + x-schemaName: AdminInitiateReturnRequest + required: + - order_id + properties: + order_id: + type: string + title: order_id + description: The ID of the order the return belongs to. + location_id: + type: string + title: location_id + description: The ID of the location the items are returned to. + description: + type: string + title: description + description: The return's description. + internal_note: + type: string + title: internal_note + description: A note viewed only by admin users. + no_notification: + type: boolean + title: no_notification + description: Whether to send the customer a notification about the created return. + metadata: + type: object + description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminInventoryItem: type: object description: The inventory item's details. @@ -62626,7 +66552,7 @@ components: title: remove description: The ID of a product. x-schemaName: AdminLinkPriceListProducts - AdminMarkPaymentCollectionPaid: + AdminMarkPaymentCollectionAsPaid: type: object description: The payment details. required: @@ -62636,7 +66562,7 @@ components: type: string title: order_id description: The ID of the order associated with the payment collection. - x-schemaName: AdminMarkPaymentCollectionPaid + x-schemaName: AdminMarkPaymentCollectionAsPaid AdminNotification: type: object description: The notification's details. @@ -62754,13 +66680,13 @@ components: - items - shipping_methods - status - - currency_code - id - version - region_id - customer_id - sales_channel_id - email + - currency_code - payment_status - fulfillment_status - summary @@ -63111,7 +67037,6 @@ components: - created_at - updated_at - order_id - - canceled_at - return_id - exchange_id - claim_id @@ -63123,6 +67048,7 @@ components: - declined_reason - declined_at - canceled_by + - canceled_at properties: id: type: string @@ -63726,13 +67652,13 @@ components: - 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 @@ -64819,201 +68745,6 @@ components: type: boolean title: no_notification description: Whether to send the customer a notification about the return's cancelation. - AdminPostClaimItemsReqSchema: - type: object - description: The details of the order items to add to the claim. - x-schemaName: AdminPostClaimItemsReqSchema - properties: - items: - type: array - description: The item's details. - items: - type: object - description: An item's details. - required: - - id - - quantity - properties: - id: - type: string - title: id - description: The ID of the order's item. - quantity: - type: number - title: quantity - description: The quantity of the order's item to add to the claim. - reason: - type: string - description: The reason the item is claimed. - enum: - - missing_item - - wrong_item - - production_failure - - other - description: - type: string - title: description - description: The item's description. - internal_note: - type: string - title: internal_note - description: A note that's only viewed by admin users. - AdminPostClaimsAddItemsReqSchema: - 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 - AdminPostClaimsItemsActionReqSchema: - type: object - description: The details to update in the item. - x-schemaName: AdminPostClaimsItemsActionReqSchema - 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. - AdminPostClaimsShippingActionReqSchema: - type: object - description: The details to update in the shipping method. - x-schemaName: AdminPostClaimsShippingActionReqSchema - 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 - AdminPostClaimsShippingReqSchema: - type: object - description: The details of the shipping method used to ship outbound items. - x-schemaName: AdminPostClaimsShippingReqSchema - 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 a custom price for the shipping method. - description: - type: string - title: description - description: The shipping method's description. - 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 - AdminPostExchangesAddItemsReqSchema: - type: object - description: The details of outbound items. - x-schemaName: AdminPostExchangesAddItemsReqSchema - properties: - items: - type: array - description: The details of outbound items. - 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 item's quantity. - 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. - allow_backorder: - type: boolean - title: allow_backorder - description: Whether the item can be added even if it's not in stock. - 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 - AdminPostExchangesItemsActionReqSchema: - type: object - description: The details to update in an outbound item. - x-schemaName: AdminPostExchangesItemsActionReqSchema - properties: - quantity: - type: number - title: quantity - description: The item's quantity. - internal_note: - type: string - title: internal_note - description: A note only viewed by admin users. AdminPostExchangesRequestItemsReturnActionReqSchema: type: object description: The details to update in an inbound (returned) item. @@ -65037,135 +68768,6 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminPostExchangesReturnRequestItemsReqSchema: - type: object - description: The details of the inbound (return) items. - x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema - properties: - items: - type: array - description: The details of the inbound (return) items. - items: - type: object - description: An item's details. - required: - - id - - quantity - properties: - id: - type: string - title: id - description: The ID of the order's item. - 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. - reason_id: - type: string - title: reason_id - description: The ID of the return reason to associate with the item. - 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 - location_id: - type: string - title: location_id - description: The ID of the location to which outbound items are sent from. - AdminPostExchangesShippingActionReqSchema: - type: object - description: The details of the shipping method to update. - x-schemaName: AdminPostExchangesShippingActionReqSchema - 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 - AdminPostExchangesShippingReqSchema: - type: object - description: The outbound shipping method's details. - x-schemaName: AdminPostExchangesShippingReqSchema - 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 a custom amount for 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 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 - AdminPostOrderClaimsReqSchema: - type: object - description: The claim's details. - x-schemaName: AdminPostOrderClaimsReqSchema - required: - - type - - order_id - properties: - type: - type: string - description: The claim's type. - enum: - - refund - - replace - order_id: - type: string - title: order_id - description: The ID of the order the claim is created for. - description: - type: string - title: description - description: The claim's description. - 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 AdminPostOrderEditsAddItemsReqSchema: type: object description: The details of items to be edited. @@ -65328,59 +68930,6 @@ components: type: number title: compare_at_unit_price description: The original price of the item before a promotion or sale. - AdminPostOrderExchangesReqSchema: - type: object - description: The exchange's details. - x-schemaName: AdminPostOrderExchangesReqSchema - required: - - order_id - properties: - order_id: - type: string - title: order_id - description: The ID of the order this exchange is created for. - description: - type: string - title: description - description: The exchange'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 - AdminPostReceiveReturnsReqSchema: - type: object - description: The return receival details. - x-schemaName: AdminPostReceiveReturnsReqSchema - properties: - internal_note: - type: string - title: internal_note - description: A note viewed only by admin users. - description: - type: string - title: description - description: The return's description. - metadata: - type: object - description: The return's metadata, can hold custom key-value pairs. - externalDocs: - url: https://docs.medusajs.com/api/admin#manage-metadata - description: Learn how to manage metadata - AdminPostReturnsConfirmRequestReqSchema: - type: object - description: The confirmation's details. - x-schemaName: AdminPostReturnsConfirmRequestReqSchema - properties: - no_notification: - type: boolean - title: no_notification - description: Whether to send the customer a notification about the confirmation. AdminPostReturnsDismissItemsActionReqSchema: type: object description: The details to update of the damaged item. @@ -65407,70 +68956,6 @@ components: type: string title: internal_note description: A note viewed only by admin users. - AdminPostReturnsReceiveItemsReqSchema: - type: object - description: The items details. - x-schemaName: AdminPostReturnsReceiveItemsReqSchema - 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. - 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. - AdminPostReturnsReqSchema: - type: object - description: The return's details. - x-schemaName: AdminPostReturnsReqSchema - required: - - order_id - properties: - order_id: - type: string - title: order_id - description: The ID of the order the return belongs to. - location_id: - type: string - title: location_id - description: The ID of the location the items are returned to. - description: - type: string - title: description - description: The return's description. - internal_note: - type: string - title: internal_note - description: A note viewed only by admin users. - no_notification: - type: boolean - title: no_notification - description: Whether to send the customer a notification about the created return. - metadata: - type: object - description: The return's metadata, can hold custom key-value pairs. - externalDocs: - url: https://docs.medusajs.com/api/admin#manage-metadata - description: Learn how to manage metadata AdminPostReturnsRequestItemsActionReqSchema: type: object description: The details to update in the item. @@ -65535,44 +69020,6 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminPostReturnsReturnReqSchema: - type: object - description: The return's details. - x-schemaName: AdminPostReturnsReturnReqSchema - properties: - location_id: - type: string - title: location_id - description: The ID of the location to return items to. - no_notification: - type: boolean - title: no_notification - description: Whether the customer should receive notifications about updates to the return. - metadata: - type: object - description: The return's metadata, can hold custom key-value pairs. - externalDocs: - url: https://docs.medusajs.com/api/admin#manage-metadata - description: Learn how to manage metadata - AdminPostReturnsShippingActionReqSchema: - type: object - description: The shipping method's details. - x-schemaName: AdminPostReturnsShippingActionReqSchema - properties: - custom_amount: - type: number - title: custom_amount - description: Set a custom price for the shipping method. - internal_note: - type: string - title: internal_note - description: A note viewed only by admin users. - metadata: - type: object - description: The return's metadata, can hold custom key-value pairs. - externalDocs: - url: https://docs.medusajs.com/api/admin#manage-metadata - description: Learn how to manage metadata AdminPostReturnsShippingReqSchema: type: object description: The shipping method's details. @@ -66039,13 +69486,13 @@ components: - length - title - status - - description - id - created_at - updated_at - subtitle - thumbnail - handle + - description - is_giftcard - width - weight @@ -66408,6 +69855,13 @@ components: 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 @@ -66762,6 +70216,7 @@ components: - barcode - ean - upc + - thumbnail - allow_backorder - manage_inventory - hs_code @@ -66892,6 +70347,15 @@ components: description: The variant's inventory items. items: $ref: '#/components/schemas/AdminProductVariantInventoryItemLink' + images: + type: array + description: The variant's images. + items: + $ref: '#/components/schemas/AdminProductImage' + thumbnail: + type: string + title: thumbnail + description: The variant's thumbnail. AdminProductVariantDeleteResponse: type: object description: The details of the product variant's deletion. @@ -67229,6 +70693,37 @@ components: - cusgroup_123 items: $ref: '#/components/schemas/BasePromotionRuleValue' + AdminReceiveItems: + type: object + description: The items details. + x-schemaName: AdminReceiveItems + 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. + 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. AdminRedeemGiftCard: type: object description: The details of the gift card to redeem. @@ -67279,6 +70774,23 @@ components: $ref: '#/components/schemas/BasePayment' refund_reason: $ref: '#/components/schemas/BaseRefundReason' + AdminRefundPayment: + type: object + description: The refund's details. + properties: + amount: + type: number + title: amount + description: The amount to refund. + refund_reason_id: + type: string + title: refund_reason_id + description: The ID of a refund reason. + note: + type: string + title: note + description: A note to attach to the refund. + x-schemaName: AdminRefundPayment AdminRefundReason: type: object description: The refund reason's details. @@ -67349,9 +70861,9 @@ components: description: The region's details. x-schemaName: AdminRegion required: - - name - - currency_code - id + - currency_code + - name properties: id: type: string @@ -67453,6 +70965,25 @@ components: type: string title: promo_codes description: A promotion code to remove from the draft order. + AdminRequestOrderTransfer: + type: object + description: The details of the request to transfer the order. + x-schemaName: AdminRequestOrderTransfer + required: + - customer_id + properties: + customer_id: + type: string + title: customer_id + description: The ID of the customer to transfer the order to. + description: + type: string + title: description + description: The description of the order transfer, which can be shown to the customer receiving the order transfer request. + internal_note: + type: string + title: internal_note + description: An internal note viewable only by admin users. AdminReservation: type: object description: The reservation's details. @@ -69384,25 +72915,6 @@ components: title: estimate_count description: The store credit account's estimate count. x-featureFlag: index_engine - AdminTransferOrder: - type: object - description: The details of the request to transfer the order. - x-schemaName: AdminTransferOrder - required: - - customer_id - properties: - customer_id: - type: string - title: customer_id - description: The ID of the customer to transfer the order to. - description: - type: string - title: description - description: The description of the order transfer, which can be shown to the customer receiving the order transfer request. - internal_note: - type: string - title: internal_note - description: An internal note viewable only by admin users. AdminUpdateApiKey: type: object description: The details to update in an API key. @@ -69414,6 +72926,40 @@ components: type: string title: title description: The API key's title. + AdminUpdateClaimItem: + type: object + description: The details to update in the item. + x-schemaName: AdminUpdateClaimItem + 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. + AdminUpdateClaimOutboundItem: + 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. AdminUpdateCustomerGroup: type: object description: The details to update in a customer group. @@ -69440,115 +72986,9 @@ components: 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: '#/components/schemas/OrderAddress' 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: '#/components/schemas/OrderAddress' metadata: type: object description: The draft order's metadata, can hold custom key-value pairs. @@ -69632,7 +73072,20 @@ components: type: string title: internal_note description: A note viewed only by admin users about the shipping method. - AdminUpdateFulfillmentSetServiceZones: + AdminUpdateExchangeOutboundItem: + type: object + description: The details to update in an outbound item. + x-schemaName: AdminUpdateExchangeOutboundItem + properties: + quantity: + type: number + title: quantity + description: The item's quantity. + internal_note: + type: string + title: internal_note + description: A note only viewed by admin users. + AdminUpdateFulfillmentSetServiceZone: type: object description: The service zone's details. properties: @@ -69790,7 +73243,7 @@ components: type: string title: id description: The ID of an existing geo zone. - x-schemaName: AdminUpdateFulfillmentSetServiceZones + x-schemaName: AdminUpdateFulfillmentSetServiceZone AdminUpdateGiftCardParams: type: object description: The details to update in the gift card. @@ -69892,7 +73345,7 @@ components: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata x-schemaName: AdminUpdateInventoryItem - AdminUpdateInventoryLocationLevel: + AdminUpdateInventoryLevel: type: object description: The properties to update in the inventory level. properties: @@ -69904,7 +73357,7 @@ components: type: number title: incoming_quantity description: The inventory level's incoming quantity. - x-schemaName: AdminUpdateInventoryLocationLevel + x-schemaName: AdminUpdateInventoryLevel AdminUpdateOrder: type: object description: The details to update in the order. @@ -69916,138 +73369,15 @@ components: 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: '#/components/schemas/OrderAddress' 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: '#/components/schemas/OrderAddress' metadata: type: object description: The order's metadata, can hold custom key-value pairs. externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminUpdatePaymentRefundReason: - type: object - description: The properties to update in the refund reason. - properties: - label: - type: string - title: label - description: The refund reason's label. - description: - type: string - title: description - description: The refund reason's description. - code: - type: string - title: code - description: The refund reason's code. - x-schemaName: AdminUpdatePaymentRefundReason AdminUpdatePriceList: type: object description: the details to update in a price list. @@ -70474,6 +73804,29 @@ components: description: An attribute value. example: prod_123 x-schemaName: AdminUpdatePromotionRule + AdminUpdateRefundReason: + type: object + description: The properties to update in the refund reason. + properties: + label: + type: string + title: label + description: The refund reason's label. + description: + type: string + title: description + description: The refund reason's description. + code: + type: string + title: code + description: The refund reason's code. + metadata: + type: object + description: The refund reason's metadata. + x-schemaName: AdminUpdateRefundReason + required: + - label + - code AdminUpdateRegion: type: object description: The propeties to update in the region. @@ -70538,6 +73891,29 @@ components: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata x-schemaName: AdminUpdateReservation + AdminUpdateReturnItems: + 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 AdminUpdateReturnReason: type: object description: The details to update in a return reason. @@ -70564,6 +73940,44 @@ components: required: - value - label + AdminUpdateReturnRequest: + type: object + description: The return's details. + x-schemaName: AdminUpdateReturnRequest + properties: + location_id: + type: string + title: location_id + description: The ID of the location to return items to. + no_notification: + type: boolean + title: no_notification + description: Whether the customer should receive notifications about updates to the return. + metadata: + type: object + description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata + AdminUpdateReturnShipping: + type: object + description: The shipping method's details. + x-schemaName: AdminUpdateReturnShipping + properties: + custom_amount: + type: number + title: custom_amount + description: Set a custom price for the shipping method. + internal_note: + type: string + title: internal_note + description: A note viewed only by admin users. + metadata: + type: object + description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateSalesChannel: type: object description: The properties to update in the sales channel. @@ -70587,6 +74001,216 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata + AdminUpdateShippingOption: + 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: '#/components/schemas/AdminCreateShippingOptionType' + 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 AdminUpdateShippingOptionRule: type: object description: The properties to update in the shipping option rule. @@ -70677,49 +74301,7 @@ components: 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: '#/components/schemas/AdminUpsertStockLocationAddress' address_id: type: string title: address_id @@ -70743,24 +74325,7 @@ components: 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: '#/components/schemas/AdminUpdateStoreSupportedCurrency' default_sales_channel_id: type: string title: default_sales_channel_id @@ -70779,6 +74344,26 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata + AdminUpdateStoreSupportedCurrency: + 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 AdminUpdateTaxRate: type: object description: The properties to update in the tax rate. @@ -70796,22 +74381,7 @@ components: 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: '#/components/schemas/AdminCreateTaxRateRule' name: type: string title: name @@ -70832,6 +74402,8 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata + required: + - code AdminUpdateTaxRegion: type: object description: The details to update in a tax region. @@ -74405,6 +77977,7 @@ components: - barcode - ean - upc + - thumbnail - allow_backorder - manage_inventory - hs_code @@ -74526,6 +78099,10 @@ components: 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. BasePromotionRuleValue: type: object description: The rule value's details. @@ -75397,6 +78974,50 @@ components: - unexpected_state - invalid_argument - unknown_error + IndexInfo: + 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. InventoryLevel: type: object description: The inventory level's details @@ -77426,8 +81047,8 @@ components: x-schemaName: StoreCart required: - promotions - - currency_code - id + - currency_code - original_item_total - original_item_subtotal - original_item_tax_total @@ -79040,10 +82661,10 @@ components: properties: customer: $ref: '#/components/schemas/StoreCustomer' - StoreDeclineOrderTransferRequest: + StoreDeclineOrderTransfer: type: object description: The details of declining the order transfer request. - x-schemaName: StoreDeclineOrderTransferRequest + x-schemaName: StoreDeclineOrderTransfer required: - token properties: @@ -79164,12 +82785,12 @@ components: - items - shipping_methods - status - - currency_code - id - region_id - customer_id - sales_channel_id - email + - currency_code - payment_status - fulfillment_status - summary @@ -86317,6 +89938,10 @@ components: description: The variant's rank among its siblings. calculated_price: $ref: '#/components/schemas/BaseCalculatedPriceSet' + thumbnail: + type: string + title: thumbnail + description: The variant's thumbnail. required: - options - length @@ -86324,6 +89949,7 @@ components: - id - created_at - updated_at + - thumbnail - width - weight - height @@ -86332,12 +89958,12 @@ components: - mid_code - material - deleted_at - - sku - - barcode - manage_inventory - allow_backorder - ean - upc + - barcode + - sku StoreRegion: type: object description: The region's details. diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 0425eb038f..9ef9350b86 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -201,6 +201,14 @@ tags: x-associatedSchema: $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 description: | 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 /admin/gift-cards/{id}/redeem: $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: $ref: paths/admin_inventory-items.yaml /admin/inventory-items/location-levels/batch: @@ -1011,6 +1023,8 @@ paths: $ref: paths/admin_products_imports_{transaction_id}_confirm.yaml /admin/products/{id}: $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: $ref: paths/admin_products_{id}_options.yaml /admin/products/{id}/options/{option_id}: @@ -1023,6 +1037,8 @@ paths: $ref: paths/admin_products_{id}_variants_inventory-items_batch.yaml /admin/products/{id}/variants/{variant_id}: $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: $ref: paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}: diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml index 89c59dddb9..27f17b6267 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml @@ -39,23 +39,7 @@ post: content: application/json: schema: - type: object - 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. + $ref: ../components/schemas/AdminBatchLink.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml index bd30e0a4af..a5074b72a0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -65,6 +65,63 @@ get: type: boolean title: with_deleted 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: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml index c20d22ab3c..138d108d51 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml @@ -39,23 +39,7 @@ post: content: application/json: schema: - type: object - 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. + $ref: ../components/schemas/AdminBatchLink.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml index fc0d160305..07b856a5a4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml @@ -59,11 +59,11 @@ get: with `-`. - name: deleted_at in: query - description: The claim's deleted at. + description: Filter by the claim's deletion date. required: false schema: type: object - description: The claim's deleted at. + description: The claim's deletion date. properties: $and: type: array @@ -383,20 +383,20 @@ get: oneOf: - type: string title: status - description: The claim's status. + description: Filter by the claim's status. - type: array - description: The claim's status. + description: Filter by the claim's status. items: type: string title: status - description: The status's details. + description: The claim's status. - name: created_at in: query - description: The claim's created at. + description: Filter by the claim's creation date. required: false schema: type: object - description: The claim's created at. + description: The claim's creation date. properties: $and: type: array @@ -675,11 +675,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The claim's updated at. + description: Filter by the claim's update date. required: false schema: type: object - description: The claim's updated at. + description: The claim's update date. properties: $and: type: array @@ -1052,6 +1052,451 @@ post: prefix it will replace the entire default fields. externalDocs: 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: - api_token: [] - cookie_auth: [] @@ -1060,7 +1505,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostOrderClaimsReqSchema.yaml + $ref: ../components/schemas/AdminCreateClaim.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml index e976f2ea69..36f7ce3809 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostClaimItemsReqSchema.yaml + $ref: ../components/schemas/AdminAddClaimItems.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml index 6cf2d09271..0ce6674d39 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml @@ -49,7 +49,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml + $ref: ../components/schemas/AdminUpdateClaimItem.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml index b5e01b8964..6f3163c5b6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml @@ -50,7 +50,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml + $ref: ../components/schemas/AdminClaimUpdateInboundShipping.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml index d9d147390c..4409b4c6de 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostClaimsAddItemsReqSchema.yaml + $ref: ../components/schemas/AdminAddClaimOutboundItems.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml index e1c2f08ce7..16e2874b69 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml @@ -50,7 +50,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml + $ref: ../components/schemas/AdminUpdateClaimOutboundItem.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml index 5327b9d333..b6f3350efc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostClaimsShippingReqSchema.yaml + $ref: ../components/schemas/AdminClaimAddOutboundShipping.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml index 1a66873944..b415536746 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml @@ -50,7 +50,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml + $ref: ../components/schemas/AdminClaimUpdateOutboundShipping.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml index e0cca246cc..96763cf565 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml @@ -39,23 +39,7 @@ post: content: application/json: schema: - type: object - description: The products to add or remove. - properties: - add: - type: array - description: The products to add to the collection. - items: - type: string - title: add - description: A product's ID. - remove: - type: array - description: The products to remove from the collection. - items: - type: string - title: remove - description: A product's ID. + $ref: ../components/schemas/AdminBatchLink.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml index 1d301dab93..f365f5c345 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml @@ -37,23 +37,7 @@ post: content: application/json: schema: - type: object - description: The customers to add or remove from the group. - properties: - add: - type: array - description: The customers to add to the group. - items: - type: string - title: add - description: A customer's ID. - remove: - type: array - description: The customers to remove from the group. - items: - type: string - title: remove - description: A customer's ID. + $ref: ../components/schemas/AdminBatchLink.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml index a0f0f81423..3b82d120fb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml @@ -51,23 +51,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - properties: - add: - type: array - description: The customer groups to add the customer to. - items: - type: string - title: add - description: The ID of the group to add the customer to. - remove: - type: array - description: The customer groups to remove the customer from. - items: - type: string - title: remove - description: The ID of the group to remove the customer from. + $ref: ../components/schemas/AdminBatchLink.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_convert-to-order.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_convert-to-order.yaml index 5375db6df1..971cd13ec7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_convert-to-order.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_convert-to-order.yaml @@ -13,26 +13,6 @@ post: required: true schema: type: string - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. - - if a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. - - without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - If a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. Without - prefix it will replace the entire default fields. - externalDocs: - url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -52,6 +32,10 @@ post: responses: '200': description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -79,3 +63,8 @@ post: order. deprecated: false + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminDraftOrderParams.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml index f5b5b75e1f..1b75e6644e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -1013,7 +1013,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostOrderExchangesReqSchema.yaml + $ref: ../components/schemas/AdminCreateExchange.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml index d5f26c541f..5f3e88f0fe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml @@ -13,6 +13,24 @@ post: required: true schema: type: string + - name: fields + in: query + description: >- + Comma-separated fields that should be included in the returned data. If + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. Without prefix it will + replace the entire default fields. + required: false + schema: + type: string + title: fields + description: >- + Comma-separated fields that should be included in the returned data. + If a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. Without + prefix it will replace the entire default fields. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -21,8 +39,7 @@ post: content: application/json: schema: - $ref: >- - ../components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml + $ref: ../components/schemas/AdminAddExchangeInboundItems.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml index 38f5f896fd..2b4b21bd2d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml @@ -50,7 +50,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostExchangesShippingActionReqSchema.yaml + $ref: ../components/schemas/AdminExchangeUpdateInboundShipping.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml index 1975721281..09726e99fd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml @@ -38,7 +38,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostExchangesAddItemsReqSchema.yaml + $ref: ../components/schemas/AdminAddExchangeOutboundItems.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml index f5d00dc892..da7ce10c1b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml @@ -50,7 +50,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostExchangesItemsActionReqSchema.yaml + $ref: ../components/schemas/AdminUpdateExchangeOutboundItem.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml index c59c8f8205..b0f746a729 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostExchangesShippingReqSchema.yaml + $ref: ../components/schemas/AdminExchangeAddOutboundShipping.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml index 499e5e099c..0b194ab64e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml @@ -50,7 +50,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostExchangesShippingActionReqSchema.yaml + $ref: ../components/schemas/AdminExchangeUpdateOutboundShipping.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml index 3d99e4647c..c86e2f8cfb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml @@ -37,7 +37,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateFulfillmentSetServiceZones.yaml + $ref: ../components/schemas/AdminCreateFulfillmentSetServiceZone.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml index 2bf0c07070..dedef09d09 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml @@ -116,7 +116,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml + $ref: ../components/schemas/AdminUpdateFulfillmentSetServiceZone.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml index b32fb98761..97f30b9ae8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateShipment.yaml + $ref: ../components/schemas/AdminCreateFulfillmentShipment.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_index_details.yaml b/www/apps/api-reference/specs/admin/paths/admin_index_details.yaml new file mode 100644 index 0000000000..21fc202777 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_index_details.yaml @@ -0,0 +1,40 @@ +get: + operationId: GetIndexDetails + summary: Get Index Details + description: >- + Retrieve index metadata, including entity type, status, last synced key, and + last updated timestamp. + x-authenticated: true + parameters: [] + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_index_details/get.sh + tags: + - Index + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminIndexDetailsResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-since: 2.11.2 + x-featureFlag: index diff --git a/www/apps/api-reference/specs/admin/paths/admin_index_sync.yaml b/www/apps/api-reference/specs/admin/paths/admin_index_sync.yaml new file mode 100644 index 0000000000..d1bbe61dda --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_index_sync.yaml @@ -0,0 +1,39 @@ +post: + operationId: PostIndexSync + summary: Trigger Index Sync + description: Trigger reindexing or re-ingestion of the Index Module. + x-authenticated: true + parameters: [] + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminIndexSyncPayload.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_index_sync/post.sh + tags: + - Index + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-since: 2.11.2 + x-featureFlag: index diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml index 515f588c7a..24e037412f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml @@ -64,28 +64,6 @@ get: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - - name: $and - in: query - 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 - required: false - schema: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $or - name: with_deleted in: query description: Whether to include deleted records in the result. @@ -94,6 +72,20 @@ get: type: boolean title: with_deleted description: Whether to include deleted records in the result. + - name: location_id + in: query + required: false + schema: + oneOf: + - type: string + title: location_id + description: Filter by the inventory item's location ID. + - type: array + description: The inventory item's location IDs. + items: + type: string + title: location_id + description: The location ID. security: - api_token: [] - cookie_auth: [] @@ -200,7 +192,8 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateInventoryLocationLevel.yaml + $ref: >- + ../components/schemas/AdminBatchCreateInventoryItemLocationLevels.yaml x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml index 69ebdf89c3..79b966d98d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml @@ -45,7 +45,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminUpdateInventoryLocationLevel.yaml + $ref: ../components/schemas/AdminUpdateInventoryLevel.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml index 3e9900d87c..0122f9885d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml @@ -30,34 +30,6 @@ get: prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' - - name: id - in: query - required: false - schema: - oneOf: - - type: string - title: id - description: The order's ID. - - type: array - description: The order's ID. - items: - type: string - title: id - description: The id's ID. - - name: status - in: query - required: false - schema: - oneOf: - - type: string - title: status - description: The order's status. - - type: array - description: The order's status. - items: - type: string - title: status - description: The status's details. - name: version in: query description: The order's version. @@ -66,18 +38,6 @@ get: type: number title: version description: The order's version. - - name: created_at - in: query - required: false - schema: {} - - name: updated_at - in: query - required: false - schema: {} - - name: deleted_at - in: query - required: false - schema: {} security: - api_token: [] - cookie_auth: [] @@ -146,6 +106,14 @@ post: prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' + - name: version + in: query + description: The version of the order to retrieve. + required: false + schema: + type: number + title: version + description: The version of the order to retrieve. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml index 2b65c68c86..b7f3b2e081 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml @@ -7,7 +7,7 @@ get: etc... - The changes can be filtered by fields like FILTER FIELDS. The changes can + The changes can be filtered by fields like `created_at`. The changes can also be paginated. x-authenticated: true parameters: @@ -37,6 +37,940 @@ get: fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. + - name: created_at + in: query + description: Filter by the order change's creation date. + required: false + schema: + type: object + description: Filter by the order change's creation date. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's content + is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's content + is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the values of this + parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: >- + Filter arrays that have overlapping values with this + parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for numbers + and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. Useful + for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for numbers and + dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. Useful for + numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: updated_at + in: query + description: Filter by the order change's update date. + required: false + schema: + type: object + description: Filter by the order change's update date. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's content + is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's content + is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the values of this + parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: >- + Filter arrays that have overlapping values with this + parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for numbers + and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. Useful + for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for numbers and + dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. Useful for + numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: deleted_at + in: query + description: Filter by the order change's deletion date. + required: false + schema: + type: object + description: Filter by the order change'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 multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the values of this + parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: >- + Filter arrays that have overlapping values with this + parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for numbers + and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. Useful + for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for numbers and + dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. Useful for + numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by an order change ID. + - type: array + description: Filter by order change IDs. + items: + type: string + title: id + description: An order change ID. + - type: object + description: The order's ID. + 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 + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: Filter by the order change's status. + - type: array + description: Filter by multiple order change statuses. + items: + type: string + title: status + description: An order change status. + - type: object + description: The order change's status. + 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 + - name: change_type + in: query + required: false + schema: + oneOf: + - type: string + title: change_type + description: Filter by the order change's type. + - type: array + description: Filter by multiple order change types. + items: + type: string + title: change_type + description: An order change type. + - type: object + description: Filter the order change's type. + 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 + - 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: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_credit-lines.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_credit-lines.yaml index b740a29d1e..a63a0df590 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_credit-lines.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_credit-lines.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateOrderCreditLines.yaml + $ref: ../components/schemas/AdminCreateOrderCreditLine.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml index 7c15d6de07..630fdc3f2d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -18,24 +18,6 @@ post: required: true schema: type: string - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - externalDocs: - url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_line-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_line-items.yaml index 8e8fa778f5..e77334ec93 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_line-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_line-items.yaml @@ -74,41 +74,6 @@ get: type: number title: version description: The version's details. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - externalDocs: - url: '#pagination' - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - externalDocs: - url: '#pagination' - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - externalDocs: - url: '#pagination' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer.yaml index bc27ad20e3..a9b2a5c54c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer.yaml @@ -43,7 +43,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminTransferOrder.yaml + $ref: ../components/schemas/AdminRequestOrderTransfer.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml index 9665f256ff..bba3174baf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminMarkPaymentCollectionPaid.yaml + $ref: ../components/schemas/AdminMarkPaymentCollectionAsPaid.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml index 7bf7b71e8d..8609d57c76 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml @@ -38,7 +38,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreatePaymentCapture.yaml + $ref: ../components/schemas/AdminCapturePayment.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml index 58c7d685b7..5598902a68 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml @@ -38,7 +38,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreatePaymentRefund.yaml + $ref: ../components/schemas/AdminRefundPayment.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml index 9da2274da3..8781d61858 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml @@ -475,6 +475,401 @@ post: prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' + - name: q + in: query + description: Apply a search query to the price list's searchable properties. + required: false + schema: + type: string + title: q + description: Apply a search query to the price list's searchable properties. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by a specific price list ID. + - type: array + description: Filter by multiple price list IDs. + items: + type: string + title: id + description: A price list ID. + - name: starts_at + in: query + description: Filter by a price list's start date. + required: false + schema: + type: object + description: Filter by a price list's start 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: ends_at + in: query + description: Filter by a price list's end date. + required: false + schema: + type: object + description: Filter by a price list's end 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: status + in: query + description: Filter by price list statuses. + required: false + schema: + type: array + description: Filter by price list statuses. + items: + type: string + description: A price list status. + enum: + - draft + - active + - name: rules_count + in: query + description: Filter by multiple price list rules count. + required: false + schema: + type: array + description: Filter by price list rules count. + items: + type: number + title: rules_count + description: A price list's rules count. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + externalDocs: + url: '#pagination' + - name: with_deleted + in: query + description: The price list's with deleted. + required: false + schema: + type: boolean + title: with_deleted + description: The price list's with deleted. + - 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: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index e94d04f7ca..eef44caddd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml @@ -717,49 +717,46 @@ post: documentation. externalDocs: url: '#select-fields-and-relations' - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - externalDocs: - url: '#pagination' - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - externalDocs: - url: '#pagination' - - name: order + - name: include_ancestors_tree in: query description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - externalDocs: - url: '#pagination' - - name: with_deleted - in: query - description: Whether to include deleted records in the result. + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific fields + to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. required: false schema: type: boolean - title: with_deleted - description: Whether to include deleted records in the result. + title: include_ancestors_tree + description: >- + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific + fields to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. + - name: include_descendants_tree + in: query + description: >- + Whether to retrieve a list of child categories. If you enable this, add + to the `fields` query parameter `category_children` to set the child of + a category in this field. You can either pass `*category_children` to + retreieve the fields of all child categories, or select specific fields + to make the response size smaller. For example, + `fields=category_children.id,category_children.name`. + required: false + schema: + type: boolean + title: include_descendants_tree + description: >- + Whether to retrieve a list of child categories. If you enable this, + add to the `fields` query parameter `category_children` to set the + child of a category in this field. You can either pass + `*category_children` to retreieve the fields of all child categories, + or select specific fields to make the response size smaller. For + example, `fields=category_children.id,category_children.name`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml index bc54617716..5344bd6248 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml @@ -78,6 +78,978 @@ get: `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`. + - name: is_internal + in: query + description: Filter by whether the product category is internal. + required: false + schema: + type: boolean + title: is_internal + description: Filter by whether the product category is internal. + - name: is_active + in: query + description: Filter by whether the product category is active. + required: false + schema: + type: boolean + title: is_active + description: Filter by whether the product category is active. + - name: q + in: query + description: Apply a search query to the product category's searchable properties. + required: false + schema: + type: string + title: q + description: Apply a search query to the product category's searchable properties. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by the product category's ID. + - type: array + description: Filter by product category IDs. + items: + type: string + title: id + description: A product category ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: Filter by the product category's name. + - type: array + description: Filter by product category names. + items: + type: string + title: name + description: A product category name. + - name: description + in: query + required: false + schema: + oneOf: + - type: string + title: description + description: Filter by the product category's description. + - type: array + description: Filter by product category descriptions. + items: + type: string + title: description + description: A product category description. + - name: parent_category_id + in: query + required: false + schema: + oneOf: + - type: string + title: parent_category_id + description: Retrieve the categories of a given parent category's ID. + - type: array + description: Retrieve the categories of the given parent category IDs. + items: + type: string + title: parent_category_id + description: A parent category ID. + - name: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: Filter by the product category's handle. + - type: array + description: Filter by product category handles. + items: + type: string + title: handle + description: A product category handle. + - name: created_at + in: query + description: Filter by the category's creation date. + required: false + schema: + type: object + description: Filter by the category's creation date. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's content + is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's content + is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the values of this + parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: >- + Filter arrays that have overlapping values with this + parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for numbers + and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. Useful + for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for numbers and + dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. Useful for + numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: updated_at + in: query + description: Filter by the category's update date. + required: false + schema: + type: object + description: Filter by the category's update date. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's content + is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's content + is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the values of this + parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: >- + Filter arrays that have overlapping values with this + parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for numbers + and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. Useful + for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for numbers and + dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. Useful for + numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: deleted_at + in: query + description: Filter by the category's deletion date. + required: false + schema: + type: object + description: Filter by the category'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 multiple exact matches. + items: + type: string + title: $eq + description: An exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value not to match. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by multiple exact matches. + items: + type: string + title: $eq + description: The value to match. + $ne: + type: string + title: $ne + description: Filter by values not matching this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: The value to match. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: The value to not match + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching this parameter + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the values of this + parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: >- + Filter arrays that have overlapping values with this + parameter. + items: + type: string + title: $overlap + description: The value to match. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + - type: array + description: Filter by values not matching those in this parameter. + items: + type: string + title: $not + description: The values to not match. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for numbers + and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. Useful + for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for numbers and + dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. Useful for + numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: The values to match. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: The values to match. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: The values to match. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + externalDocs: + url: '#pagination' + - name: with_deleted + in: query + description: The product category's with deleted. + required: false + schema: + type: boolean + title: with_deleted + description: The product category's with deleted. + - 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: - api_token: [] - cookie_auth: [] @@ -150,6 +1122,46 @@ post: documentation. externalDocs: url: '#select-fields-and-relations' + - name: include_ancestors_tree + in: query + description: >- + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific fields + to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. + required: false + schema: + type: boolean + title: include_ancestors_tree + description: >- + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific + fields to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. + - name: include_descendants_tree + in: query + description: >- + Whether to retrieve a list of child categories. If you enable this, add + to the `fields` query parameter `category_children` to set the child of + a category in this field. You can either pass `*category_children` to + retreieve the fields of all child categories, or select specific fields + to make the response size smaller. For example, + `fields=category_children.id,category_children.name`. + required: false + schema: + type: boolean + title: include_descendants_tree + description: >- + Whether to retrieve a list of child categories. If you enable this, + add to the `fields` query parameter `category_children` to set the + child of a category in this field. You can either pass + `*category_children` to retreieve the fields of all child categories, + or select specific fields to make the response size smaller. For + example, `fields=category_children.id,category_children.name`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml index a9e5360c92..d795f4684f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml @@ -37,6 +37,46 @@ post: documentation. externalDocs: url: '#select-fields-and-relations' + - name: include_ancestors_tree + in: query + description: >- + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific fields + to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. + required: false + schema: + type: boolean + title: include_ancestors_tree + description: >- + Whether to retrieve the category's parent. If you enable this, add to + the `fields` query parameter `parent_category` to set the parent of a + category in this field. You can either pass `*parent_category` to + retreieve the fields of all parent categories, or select specific + fields to make the response size smaller. For example, + `fields=parent_category.id,parent_category.name`. + - name: include_descendants_tree + in: query + description: >- + Whether to retrieve a list of child categories. If you enable this, add + to the `fields` query parameter `category_children` to set the child of + a category in this field. You can either pass `*category_children` to + retreieve the fields of all child categories, or select specific fields + to make the response size smaller. For example, + `fields=category_children.id,category_children.name`. + required: false + schema: + type: boolean + title: include_descendants_tree + description: >- + Whether to retrieve a list of child categories. If you enable this, + add to the `fields` query parameter `category_children` to set the + child of a category in this field. You can either pass + `*category_children` to retreieve the fields of all child categories, + or select specific fields to make the response size smaller. For + example, `fields=category_children.id,category_children.name`. security: - api_token: [] - cookie_auth: [] @@ -45,23 +85,7 @@ post: content: application/json: schema: - type: object - description: The products to add or remove from the category. - properties: - add: - type: array - description: The products to add. - items: - type: string - title: add - description: A product ID. - remove: - type: array - description: The product to remove. - items: - type: string - title: remove - description: A product ID. + $ref: ../components/schemas/AdminBatchLink.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_products.yaml index e98fef46ce..da873096ac 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -848,7 +848,7 @@ get: `null`). updated_at: type: object - description: The variant's updated at. + description: Filter by the variant's update date. properties: $and: type: array @@ -1183,35 +1183,47 @@ get: oneOf: - type: string title: ean - description: The variant's ean. + description: Filter by a variant's ean. - type: array - description: The variant's ean. + description: Filter by variant eans. items: type: string title: ean - description: The ean's details. + description: A variant's ean. upc: oneOf: - type: string title: upc - description: The variant's upc. + description: Filter by a variant's upc. - type: array - description: The variant's upc. + description: Filter by variant upcs. items: type: string title: upc - description: The upc's details. + description: A variant's upc. barcode: oneOf: - type: string title: barcode - description: The variant's barcode. + description: Filter by a variant's barcode. - type: array - description: The variant's barcode. + description: Filter by variant barcodes. items: type: string title: barcode - description: The barcode's details. + description: A variant's barcode. + with_deleted: + type: boolean + title: with_deleted + description: Whether to include deleted variants. + - name: with_deleted + in: query + description: Whether to include deleted products. + required: false + schema: + type: boolean + title: with_deleted + description: Whether to include deleted products. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml index 198c62cac6..1dcc7af13b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml @@ -32,6 +32,683 @@ post: prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' + - name: tags + in: query + description: Filter products by their tags. + required: false + schema: + type: object + description: Filter products by their tags. + properties: + id: + type: array + description: Filter by tag IDs. + items: + type: string + title: id + description: A tag ID. + - name: variants + in: query + description: Filter the products' variants. + required: false + schema: + type: object + description: Filter the products' variants. + properties: + options: + type: object + description: Filter the variants by their options. + properties: + value: + type: string + title: value + description: The option's value. + option_id: + type: string + title: option_id + description: The option's ID. + option: + type: object + description: The option's details. + - name: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: Filter products by their title. + - type: array + description: Filter products by multiple titles. + items: + type: string + title: title + description: A product title. + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: Filter products by their status. + enum: + - draft + - proposed + - published + - rejected + - type: array + description: Filter products by multiple statuses. + items: + type: string + description: A product status. + enum: + - draft + - proposed + - published + - rejected + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter products by their ID. + - type: array + description: Filter products by multiple IDs. + items: + type: string + title: id + description: A product ID. + - name: sales_channel_id + in: query + required: false + schema: + oneOf: + - type: string + title: sales_channel_id + description: Filter products by their sales channel ID. + - type: array + description: Filter products by multiple sales channel IDs. + items: + type: string + title: sales_channel_id + description: A sales channel ID. + - name: created_at + in: query + description: Filter by a product's creation date. + required: false + schema: + type: object + description: Filter by a product'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 product's update date. + required: false + schema: + type: object + description: Filter by a product'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: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: Filter products by their handle. + - type: array + description: Filter products by multiple handles. + items: + type: string + title: handle + description: A product handle. + - name: is_giftcard + in: query + description: Filter products by whether they are gift cards. + required: false + schema: + type: boolean + title: is_giftcard + description: Whether the product is a gift card. + - name: collection_id + in: query + required: false + schema: + oneOf: + - type: string + title: collection_id + description: Filter products by their collection ID. + - type: array + description: Filter products by multiple collection IDs. + items: + type: string + title: collection_id + description: A collection ID. + - name: type_id + in: query + required: false + schema: + oneOf: + - type: string + title: type_id + description: Filter products by their type ID. + - type: array + description: Filter products by multiple type IDs. + items: + type: string + title: type_id + description: The type ID's details. + - name: deleted_at + in: query + description: Filter by a product's deletion date. + required: false + schema: + type: object + description: Filter by a product'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`). + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + externalDocs: + url: '#pagination' + - name: q + in: query + description: The product's q. + required: false + schema: + type: string + title: q + description: The product's q. + - name: category_id + in: query + required: false + schema: + oneOf: + - type: string + title: category_id + description: Filter products by their category ID. + - type: array + description: Filter products by their category IDs. + items: + type: string + title: category_id + description: A category ID. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' + - name: with_deleted + in: query + description: The product's with deleted. + required: false + schema: + type: boolean + title: with_deleted + description: The product's with deleted. + - name: $and + in: query + description: >- + Join query parameters with an AND condition. Each object's content is + the same type as the expected query parameters. + required: false + schema: + type: array + description: >- + Join query parameters with an AND condition. Each object's content is + the same type as the expected query parameters. + items: + type: object + title: $and + - name: $or + in: query + description: >- + Join query parameters with an OR condition. Each object's content is the + same type as the expected query parameters. + required: false + schema: + type: array + description: >- + Join query parameters with an OR condition. Each object's content is + the same type as the expected query parameters. + items: + type: object + title: $or + - name: price_list_id + in: query + required: false + schema: + oneOf: + - type: string + title: price_list_id + description: Filter products by the ID of a price list they belong to. + - type: array + description: Filter products by the IDs of price lists they belong to. + items: + type: string + title: price_list_id + description: A price list ID. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_images_{image_id}_variants_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_images_{image_id}_variants_batch.yaml new file mode 100644 index 0000000000..5ec422a958 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_images_{image_id}_variants_batch.yaml @@ -0,0 +1,64 @@ +post: + operationId: PostProductsIdImagesImage_idVariantsBatch + summary: Manage Variants of Product Image + description: >- + Manage the association between product variants and a product image. You can + add or remove associations between variants and the image. + x-authenticated: true + parameters: + - name: id + in: path + description: The product's ID. + required: true + schema: + type: string + - name: image_id + in: path + description: The product image's ID. + required: true + schema: + type: string + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminBatchImageVariantRequest.yaml + x-codeSamples: + - lang: JavaScript + label: JS SDK + source: + $ref: >- + ../code_samples/JavaScript/admin_products_{id}_images_{image_id}_variants_batch/post.js + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_products_{id}_images_{image_id}_variants_batch/post.sh + tags: + - Products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminBatchImageVariantResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: batchImageVariantsWorkflow + x-events: [] + x-since: 2.11.2 diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml index bc0310181e..4c0629924b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml @@ -37,8 +37,8 @@ post: inventory item. required: - variant_id - - inventory_item_id - required_quantity + - inventory_item_id properties: required_quantity: type: number @@ -71,8 +71,8 @@ post: description: Update a product variant's association with an inventory item. required: - variant_id - - inventory_item_id - required_quantity + - inventory_item_id properties: required_quantity: type: number diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_images_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_images_batch.yaml new file mode 100644 index 0000000000..6c733b308b --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_images_batch.yaml @@ -0,0 +1,64 @@ +post: + operationId: PostProductsIdVariantsVariant_idImagesBatch + summary: Manage Images of Product Variant + description: >- + Manage the association between product images and a product variant. You can + add or remove associations between images and the variant. + x-authenticated: true + parameters: + - name: id + in: path + description: The product's ID. + required: true + schema: + type: string + - name: variant_id + in: path + description: The product variant's ID. + required: true + schema: + type: string + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminBatchVariantImagesRequest.yaml + x-codeSamples: + - lang: JavaScript + label: JS SDK + source: + $ref: >- + ../code_samples/JavaScript/admin_products_{id}_variants_{variant_id}_images_batch/post.js + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_products_{id}_variants_{variant_id}_images_batch/post.sh + tags: + - Products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminBatchVariantImagesResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: batchVariantImagesWorkflow + x-events: [] + x-since: 2.11.2 diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml index bded42bbd8..40350bf360 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml @@ -60,28 +60,6 @@ get: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - - name: promotion_type - in: query - description: The promotion type to retrieve rules for. - required: false - schema: - type: string - title: promotion_type - description: The promotion type to retrieve rules for. - enum: - - standard - - buyget - - name: application_method_type - in: query - description: The application method type to retrieve rules for. - required: false - schema: - type: string - title: application_method_type - description: The application method type to retrieve rules for. - enum: - - fixed - - percentage - name: with_deleted in: query description: Whether to include deleted records in the result. @@ -96,8 +74,47 @@ get: required: false schema: type: string - title: application_method_target_type description: The application method target type to retrieve rules for. + - name: q + in: query + description: Apply a search query on the rule values' searchable properties. + required: false + schema: + type: string + title: q + description: Apply a search query on the rule values' searchable properties. + - name: value + in: query + required: false + schema: + oneOf: + - type: string + title: value + description: Filter by a specific rule value. + - type: array + description: Filter by multiple rule values. + items: + type: string + title: value + description: A rule value. + - name: fields + in: query + description: >- + Comma-separated fields that should be included in the returned data. If + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. Without prefix it will + replace the entire default fields. + required: false + schema: + type: string + title: fields + description: >- + Comma-separated fields that should be included in the returned data. + If a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. Without + prefix it will replace the entire default fields. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml index 5afc419b9b..40d0fb2364 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml @@ -13,24 +13,37 @@ post: required: true schema: type: string - - name: fields + - name: promotion_type in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. + description: The promotion's type. required: false schema: type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - externalDocs: - url: '#select-fields-and-relations' + description: The promotion's type. + enum: + - standard + - buyget + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + description: The promotion's application method type. + enum: + - fixed + - percentage + - name: application_method_target_type + in: query + description: The promotion's application method target type. + required: false + schema: + type: string + description: The promotion's application method target type. + enum: + - items + - shipping_methods + - order security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml index 8f07440787..4bc3496a74 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml @@ -11,24 +11,37 @@ post: required: true schema: type: string - - name: fields + - name: promotion_type in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. + description: The promotion's type. required: false schema: type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - externalDocs: - url: '#select-fields-and-relations' + description: The promotion's type. + enum: + - standard + - buyget + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + description: The promotion's application method type. + enum: + - fixed + - percentage + - name: application_method_target_type + in: query + description: The promotion's application method target type. + required: false + schema: + type: string + description: The promotion's application method target type. + enum: + - items + - shipping_methods + - order security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml index 5cf6c32e00..8e74d62482 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml @@ -11,24 +11,37 @@ post: required: true schema: type: string - - name: fields + - name: promotion_type in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. + description: The promotion's type. required: false schema: type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - externalDocs: - url: '#select-fields-and-relations' + description: The promotion's type. + enum: + - standard + - buyget + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + description: The promotion's application method type. + enum: + - fixed + - percentage + - name: application_method_target_type + in: query + description: The promotion's application method target type. + required: false + schema: + type: string + description: The promotion's application method target type. + enum: + - items + - shipping_methods + - order security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml index 50fa3f96e8..5274c81c51 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml @@ -49,6 +49,37 @@ get: prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' + - name: promotion_type + in: query + description: The type + required: false + schema: + type: string + description: The promotion's type. + enum: + - standard + - buyget + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + description: The promotion's application method type. + enum: + - fixed + - percentage + - name: application_method_target_type + in: query + description: The promotion's application method target type. + required: false + schema: + type: string + description: The promotion's application method target type. + enum: + - items + - shipping_methods + - order security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml index 5db69be643..1975dcc388 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml @@ -102,7 +102,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminUpdatePaymentRefundReason.yaml + $ref: ../components/schemas/AdminUpdateRefundReason.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml index b19b5c37cb..b7b84045cf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -614,22 +614,153 @@ get: type: boolean title: with_deleted description: Whether to include deleted records in the result. - - name: order_id + - name: q in: query + description: Apply a search query on the reservation's searchable properties. required: false schema: - oneOf: - - type: string - title: order_id - description: Filter by an order's ID to retrieve its associated reservations. - - type: array + type: string + title: q + description: Apply a search query on the reservation's searchable properties. + - name: quantity + in: query + description: Filter by the reservation's quantity. + required: false + schema: + type: object + description: Filter by a reservation's quantity. + properties: + $and: + type: array description: >- - Filter by multiple order IDs to retrieve their associated - reservations. + 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: order_id - description: An order's ID. + 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: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml index 4baea5c063..a7f0524224 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -804,7 +804,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostReturnsReqSchema.yaml + $ref: ../components/schemas/AdminInitiateReturnRequest.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml index e5e120cf79..8559a013b4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml @@ -102,7 +102,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostReturnsReturnReqSchema.yaml + $ref: ../components/schemas/AdminUpdateReturnRequest.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml index 79f015bf15..8a685fe02b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml + $ref: ../components/schemas/AdminDismissItems.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml index 20e4a9c1fc..312836b5aa 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml + $ref: ../components/schemas/AdminReceiveItems.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml index 7c93cd559b..06694879e6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml @@ -38,7 +38,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostReceiveReturnsReqSchema.yaml + $ref: ../components/schemas/AdminInitiateReceiveReturn.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml index 61c8fb8a64..a44654e992 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml @@ -38,7 +38,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml + $ref: ../components/schemas/AdminConfirmReceiveReturn.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml index fd52f968be..a2f3507afd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml + $ref: ../components/schemas/AdminAddReturnItems.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml index 5889bb9d79..159abcc180 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml @@ -50,8 +50,7 @@ post: content: application/json: schema: - $ref: >- - ../components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml + $ref: ../components/schemas/AdminUpdateReturnItems.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml index c15ed5eb05..3e19c4ae32 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml + $ref: ../components/schemas/AdminConfirmReturnRequest.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml index 993729b04e..58e66a76e7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml @@ -39,7 +39,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostReturnsShippingReqSchema.yaml + $ref: ../components/schemas/AdminAddReturnShipping.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml index a4dfac6806..5488442eb9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml @@ -50,7 +50,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostReturnsShippingActionReqSchema.yaml + $ref: ../components/schemas/AdminUpdateReturnShipping.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml index 42ddd04df8..1497af9071 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml @@ -37,23 +37,7 @@ post: content: application/json: schema: - type: object - description: The products to add or remove from the channel. - properties: - add: - type: array - description: The products to add to the sales channel. - items: - type: string - title: add - description: A product's ID. - remove: - type: array - description: The products to remove from the sales channel. - items: - type: string - title: remove - description: A product's ID. + $ref: ../components/schemas/AdminBatchLink.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml index f9044aca9f..aed6317bea 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml @@ -104,7 +104,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminUpdateShippingOptionType.yaml + $ref: ../components/schemas/AdminUpdateShippingOption.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml index 5462595df8..d2d5b00a2a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml @@ -39,23 +39,7 @@ post: content: application/json: schema: - type: object - description: The fulfillment providers to add or remove from the stock location. - properties: - add: - type: array - description: The fulfillment providers to add to the stock location. - items: - type: string - title: add - description: A fulfillment provider's ID. - remove: - type: array - description: The fulfillment providers to remove from the stock location. - items: - type: string - title: remove - description: A fulfillment provider's ID. + $ref: ../components/schemas/AdminBatchLink.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml index e491ca34b4..dacce9137e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml @@ -37,23 +37,7 @@ post: content: application/json: schema: - type: object - description: The sales channels to add or remove. - properties: - add: - type: array - description: The sales channels to add. - items: - type: string - title: add - description: A sales channel's ID. - remove: - type: array - description: The sales channels to remove. - items: - type: string - title: remove - description: A sales channel's ID. + $ref: ../components/schemas/AdminBatchLink.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml index ef2a5ccdbd..1c0f9880b6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml @@ -30,36 +30,6 @@ get: prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' - - name: province_code - in: query - description: Filter by a tax region's province code. - required: false - schema: - type: string - title: province_code - description: Filter by a tax region's province code. - - name: provider_id - in: query - description: Filter by a tax provider ID to retrieve the tax regions using it. - required: false - schema: - type: string - title: provider_id - description: Filter by a tax provider ID to retrieve the tax regions using it. - - name: metadata - in: query - description: >- - Filter by a tax region's metadata. Refer to the [Object Query - Parameter](https://docs.medusajs.com/api/admin#object) section to learn - how to filter by object fields. - required: false - schema: - type: object - description: >- - Filter by a tax region's metadata. Refer to the [Object Query - Parameter](https://docs.medusajs.com/api/admin#object) section to - learn how to filter by object fields. - title: metadata security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminAddClaimItems.yaml similarity index 95% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminAddClaimItems.yaml index d1dfd8929f..e09fc88341 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminAddClaimItems.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminAddClaimOutboundItems.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminAddClaimOutboundItems.yaml new file mode 100644 index 0000000000..8335751c69 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminAddClaimOutboundItems.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminAddExchangeInboundItems.yaml similarity index 95% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminAddExchangeInboundItems.yaml index 9056f17eb7..c5cc27d80e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminAddExchangeInboundItems.yaml @@ -1,6 +1,6 @@ type: object description: The details of the inbound (return) items. -x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema +x-schemaName: AdminAddExchangeInboundItems properties: items: type: array diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminAddExchangeOutboundItems.yaml similarity index 96% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminAddExchangeOutboundItems.yaml index 33f64855b3..d732d715b5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminAddExchangeOutboundItems.yaml @@ -1,6 +1,6 @@ type: object description: The details of outbound items. -x-schemaName: AdminPostExchangesAddItemsReqSchema +x-schemaName: AdminAddExchangeOutboundItems properties: items: type: array diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminAddReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminAddReturnItem.yaml new file mode 100644 index 0000000000..fb0cb59185 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminAddReturnItem.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminAddReturnItems.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminAddReturnItems.yaml new file mode 100644 index 0000000000..09f668e3b9 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminAddReturnItems.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminAddReturnShipping.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminAddReturnShipping.yaml new file mode 100644 index 0000000000..296fcffc1e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminAddReturnShipping.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryLocationLevel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchCreateInventoryItemLocationLevels.yaml similarity index 88% rename from www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryLocationLevel.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminBatchCreateInventoryItemLocationLevels.yaml index 6578c122f4..7e44fb47de 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryLocationLevel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchCreateInventoryItemLocationLevels.yaml @@ -15,4 +15,4 @@ properties: type: number title: incoming_quantity description: The inventory level's incoming quantity. -x-schemaName: AdminCreateInventoryLocationLevel +x-schemaName: AdminBatchCreateInventoryItemLocationLevels diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchImageVariantRequest.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchImageVariantRequest.yaml new file mode 100644 index 0000000000..c1a63fa4fe --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchImageVariantRequest.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchImageVariantResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchImageVariantResponse.yaml new file mode 100644 index 0000000000..afa618f4a4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchImageVariantResponse.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchLink.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchLink.yaml new file mode 100644 index 0000000000..7549ac6abe --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchLink.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml index c59675a8e7..a0c8e38bd7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProductVariant.yaml index bd4043cb70..12f78901ed 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProductVariant.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchVariantImagesRequest.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchVariantImagesRequest.yaml new file mode 100644 index 0000000000..98fa50c7ca --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchVariantImagesRequest.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchVariantImagesResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchVariantImagesResponse.yaml new file mode 100644 index 0000000000..c5606dfcec --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchVariantImagesResponse.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePaymentCapture.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCapturePayment.yaml similarity index 78% rename from www/apps/api-reference/specs/admin/components/schemas/AdminCreatePaymentCapture.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCapturePayment.yaml index 0064576c86..3bca2425ab 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePaymentCapture.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCapturePayment.yaml @@ -5,4 +5,4 @@ properties: type: number title: amount description: The amount to capture. -x-schemaName: AdminCreatePaymentCapture +x-schemaName: AdminCapturePayment diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimAddOutboundShipping.yaml similarity index 94% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminClaimAddOutboundShipping.yaml index ec629bd78a..5dc671b0fc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimAddOutboundShipping.yaml @@ -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: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimUpdateInboundShipping.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimUpdateInboundShipping.yaml new file mode 100644 index 0000000000..1f0fb5b06a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimUpdateInboundShipping.yaml @@ -0,0 +1,18 @@ +type: object +description: The details to update in the shipping method. +x-schemaName: AdminClaimUpdateInboundShipping +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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimUpdateOutboundShipping.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimUpdateOutboundShipping.yaml new file mode 100644 index 0000000000..235b786124 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimUpdateOutboundShipping.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminConfirmReceiveReturn.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminConfirmReceiveReturn.yaml new file mode 100644 index 0000000000..7b3af414de --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminConfirmReceiveReturn.yaml @@ -0,0 +1,8 @@ +type: object +description: The confirmation's details. +x-schemaName: AdminConfirmReceiveReturn +properties: + no_notification: + type: boolean + title: no_notification + description: Whether to send the customer a notification about the confirmation. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminConfirmReturnRequest.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminConfirmReturnRequest.yaml new file mode 100644 index 0000000000..24d917c3e4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminConfirmReturnRequest.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateClaim.yaml similarity index 95% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateClaim.yaml index b828e16fa2..384fe91e8a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateClaim.yaml @@ -1,6 +1,6 @@ type: object description: The claim's details. -x-schemaName: AdminPostOrderClaimsReqSchema +x-schemaName: AdminCreateClaim required: - type - order_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateExchange.yaml similarity index 93% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateExchange.yaml index f6f32aad33..ec14af98f8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateExchange.yaml @@ -1,6 +1,6 @@ type: object description: The exchange's details. -x-schemaName: AdminPostOrderExchangesReqSchema +x-schemaName: AdminCreateExchange required: - order_id properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml index 31eec6b3ef..131c73f63d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentItem.yaml new file mode 100644 index 0000000000..302de95181 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentItem.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentLabel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentLabel.yaml new file mode 100644 index 0000000000..6b6d0a6bdd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentLabel.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentSetServiceZone.yaml similarity index 97% rename from www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentSetServiceZone.yaml index 4d3d7c2ae0..305e2f1ec4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentSetServiceZone.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentShipment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentShipment.yaml new file mode 100644 index 0000000000..6e30221d01 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentShipment.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateOrderCreditLines.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateOrderCreditLine.yaml similarity index 94% rename from www/apps/api-reference/specs/store/components/schemas/AdminCreateOrderCreditLines.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateOrderCreditLine.yaml index edb07be15c..6db8d2d200 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateOrderCreditLines.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateOrderCreditLine.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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml index 8ff435ab5c..5f8378f8d4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceListPrice.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceListPrice.yaml new file mode 100644 index 0000000000..1d15effb6f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShipment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShipment.yaml deleted file mode 100644 index 92a29e274b..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShipment.yaml +++ /dev/null @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocationFulfillmentSet.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocationFulfillmentSet.yaml index f099300601..a849e83fb2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocationFulfillmentSet.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocationFulfillmentSet.yaml @@ -1,8 +1,8 @@ type: object description: The fulfillment set to create. required: - - type - name + - type properties: name: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml index 2de3fc7b23..23e84a8328 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDismissItems.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDismissItems.yaml new file mode 100644 index 0000000000..a22fe6e81b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDismissItems.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml index 808b078423..cd53e5a4d8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderParams.yaml new file mode 100644 index 0000000000..16568ad6fa --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderParams.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml index af04f3b1ab..e27218145f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeAddOutboundShipping.yaml similarity index 94% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminExchangeAddOutboundShipping.yaml index 577bcd7bc7..9ae972f918 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeAddOutboundShipping.yaml @@ -1,6 +1,6 @@ type: object description: The outbound shipping method's details. -x-schemaName: AdminPostExchangesShippingReqSchema +x-schemaName: AdminExchangeAddOutboundShipping required: - shipping_option_id properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeUpdateInboundShipping.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeUpdateInboundShipping.yaml new file mode 100644 index 0000000000..88ee9baa4c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeUpdateInboundShipping.yaml @@ -0,0 +1,18 @@ +type: object +description: The details of the shipping method to update. +x-schemaName: AdminExchangeUpdateInboundShipping +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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeUpdateOutboundShipping.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeUpdateOutboundShipping.yaml new file mode 100644 index 0000000000..babb49c32a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeUpdateOutboundShipping.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentDeliveryAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentDeliveryAddress.yaml new file mode 100644 index 0000000000..2d62c924d6 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentDeliveryAddress.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminIndexDetailsResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminIndexDetailsResponse.yaml new file mode 100644 index 0000000000..faad52aefc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminIndexDetailsResponse.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminIndexSyncPayload.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminIndexSyncPayload.yaml new file mode 100644 index 0000000000..9069022822 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminIndexSyncPayload.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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInitiateReceiveReturn.yaml similarity index 91% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminInitiateReceiveReturn.yaml index f4b1f18cb7..01e46855f3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInitiateReceiveReturn.yaml @@ -1,6 +1,6 @@ type: object description: The return receival details. -x-schemaName: AdminPostReceiveReturnsReqSchema +x-schemaName: AdminInitiateReceiveReturn properties: internal_note: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInitiateReturnRequest.yaml similarity index 95% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminInitiateReturnRequest.yaml index 137c180ca9..66c071b588 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInitiateReturnRequest.yaml @@ -1,6 +1,6 @@ type: object description: The return's details. -x-schemaName: AdminPostReturnsReqSchema +x-schemaName: AdminInitiateReturnRequest required: - order_id properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminMarkPaymentCollectionPaid.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminMarkPaymentCollectionAsPaid.yaml similarity index 81% rename from www/apps/api-reference/specs/admin/components/schemas/AdminMarkPaymentCollectionPaid.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminMarkPaymentCollectionAsPaid.yaml index eec1356710..438d0ff1e6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminMarkPaymentCollectionPaid.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminMarkPaymentCollectionAsPaid.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml index dc257c3f04..d5ef04cbb6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml index 36005625f3..4d3dfde938 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml index a75e92bad2..d5f3755189 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml deleted file mode 100644 index 71c3bc5ac6..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml +++ /dev/null @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml index 6674fcc3e6..13ff822552 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -9,13 +9,13 @@ required: - length - title - status - - description - id - created_at - updated_at - subtitle - thumbnail - handle + - description - is_giftcard - width - weight diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml index 1238fdf516..fd0f306a55 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml index b6c4ca8752..8656985d38 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReceiveItems.yaml similarity index 93% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminReceiveItems.yaml index c3e219537a..be353cddf5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReceiveItems.yaml @@ -1,6 +1,6 @@ type: object description: The items details. -x-schemaName: AdminPostReturnsReceiveItemsReqSchema +x-schemaName: AdminReceiveItems properties: items: type: array diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePaymentRefund.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRefundPayment.yaml similarity index 89% rename from www/apps/api-reference/specs/store/components/schemas/AdminCreatePaymentRefund.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminRefundPayment.yaml index b5be8ea589..7a3048985c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePaymentRefund.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRefundPayment.yaml @@ -13,4 +13,4 @@ properties: type: string title: note description: A note to attach to the refund. -x-schemaName: AdminCreatePaymentRefund +x-schemaName: AdminRefundPayment diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml index f8126c6286..abca8cce51 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTransferOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRequestOrderTransfer.yaml similarity index 93% rename from www/apps/api-reference/specs/store/components/schemas/AdminTransferOrder.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminRequestOrderTransfer.yaml index 675e3606c1..0581b20df3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTransferOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRequestOrderTransfer.yaml @@ -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: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateClaimItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateClaimItem.yaml new file mode 100644 index 0000000000..966d490442 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateClaimItem.yaml @@ -0,0 +1,16 @@ +type: object +description: The details to update in the item. +x-schemaName: AdminUpdateClaimItem +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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateClaimOutboundItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateClaimOutboundItem.yaml new file mode 100644 index 0000000000..c49dee29a9 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateClaimOutboundItem.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml index 8396b38deb..60e5ef43c3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateExchangeOutboundItem.yaml similarity index 84% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateExchangeOutboundItem.yaml index b751b43bd8..50f79741b6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateExchangeOutboundItem.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateFulfillmentSetServiceZone.yaml similarity index 99% rename from www/apps/api-reference/specs/store/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateFulfillmentSetServiceZone.yaml index a319aa1491..6cd3cadfdd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateFulfillmentSetServiceZone.yaml @@ -155,4 +155,4 @@ properties: type: string title: id description: The ID of an existing geo zone. -x-schemaName: AdminUpdateFulfillmentSetServiceZones +x-schemaName: AdminUpdateFulfillmentSetServiceZone diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateInventoryLocationLevel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateInventoryLevel.yaml similarity index 87% rename from www/apps/api-reference/specs/store/components/schemas/AdminUpdateInventoryLocationLevel.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateInventoryLevel.yaml index 94fba3e700..12752ace19 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateInventoryLocationLevel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateInventoryLevel.yaml @@ -9,4 +9,4 @@ properties: type: number title: incoming_quantity description: The inventory level's incoming quantity. -x-schemaName: AdminUpdateInventoryLocationLevel +x-schemaName: AdminUpdateInventoryLevel diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml index cd3ef369d9..99ef76b0ce 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePaymentRefundReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateRefundReason.yaml similarity index 71% rename from www/apps/api-reference/specs/store/components/schemas/AdminUpdatePaymentRefundReason.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateRefundReason.yaml index 132b0827dc..73a8147aca 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePaymentRefundReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateRefundReason.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnItems.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnItems.yaml new file mode 100644 index 0000000000..3f7ed31f4e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnItems.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnRequest.yaml similarity index 92% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnRequest.yaml index 638346da8c..e2b0f1a7d5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnRequest.yaml @@ -1,6 +1,6 @@ type: object description: The return's details. -x-schemaName: AdminPostReturnsReturnReqSchema +x-schemaName: AdminUpdateReturnRequest properties: location_id: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnShipping.yaml similarity index 90% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnShipping.yaml index 0ad7fb99be..a0d35d4ae1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnShipping.yaml @@ -1,6 +1,6 @@ type: object description: The shipping method's details. -x-schemaName: AdminPostReturnsShippingActionReqSchema +x-schemaName: AdminUpdateReturnShipping properties: custom_amount: type: number diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingOption.yaml new file mode 100644 index 0000000000..806201a2f1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingOption.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml index ed60861669..3747b05929 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml index 734283353b..53b1467a8b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStoreSupportedCurrency.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStoreSupportedCurrency.yaml new file mode 100644 index 0000000000..9f942d359d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStoreSupportedCurrency.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml index e79271cd68..004a02e39e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml index 74d80a6209..e23119a7a4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/IndexInfo.yaml b/www/apps/api-reference/specs/store/components/schemas/IndexInfo.yaml new file mode 100644 index 0000000000..d9cafb36bd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/IndexInfo.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml index 2ff9e3c53a..138c171d78 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreDeclineOrderTransferRequest.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreDeclineOrderTransfer.yaml similarity index 83% rename from www/apps/api-reference/specs/store/components/schemas/StoreDeclineOrderTransferRequest.yaml rename to www/apps/api-reference/specs/store/components/schemas/StoreDeclineOrderTransfer.yaml index ab03d7e6b8..128b50460c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreDeclineOrderTransferRequest.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreDeclineOrderTransfer.yaml @@ -1,6 +1,6 @@ type: object description: The details of declining the order transfer request. -x-schemaName: StoreDeclineOrderTransferRequest +x-schemaName: StoreDeclineOrderTransfer required: - token properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml index 2cedb499ba..2b757df371 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml index 5ee38cc877..2d800db80f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index e5920687b0..04ed6101ad 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -3599,44 +3599,6 @@ paths: type: string externalDocs: url: https://docs.medusajs.com/api/store#publishable-api-key - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. - externalDocs: - url: '#select-fields-and-relations' - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - externalDocs: - url: '#pagination' - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - externalDocs: - url: '#pagination' - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - name: city in: query description: Filter by the address's city. @@ -3690,14 +3652,54 @@ paths: type: string title: q description: Search term to filter the address's searchable properties. - - name: with_deleted + - name: company in: query - description: Whether to include deleted records in the result. required: false schema: - type: boolean - title: with_deleted - description: Whether to include deleted records in the result. + oneOf: + - type: string + title: company + description: Filter addresses by company. + - type: array + description: Filter addresses by companies. + items: + type: string + title: company + description: A company. + - name: province + in: query + required: false + schema: + oneOf: + - type: string + title: province + description: Filter addresses by province. + - type: array + description: Filter addresses by provinces. + items: + type: string + title: province + description: A province. + - 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: - cookie_auth: [] - jwt_token: [] @@ -4828,7 +4830,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StoreDeclineOrderTransferRequest' + $ref: '#/components/schemas/StoreDeclineOrderTransfer' x-codeSamples: - lang: JavaScript label: JS SDK @@ -8328,36 +8330,6 @@ paths: type: string title: cart_id description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - externalDocs: - url: '#pagination' - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - externalDocs: - url: '#pagination' - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - externalDocs: - url: '#pagination' x-codeSamples: - lang: JavaScript label: JS SDK @@ -9648,6 +9620,84 @@ paths: This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin). components: schemas: + AdminAddClaimItems: + type: object + description: The details of the order items to add to the claim. + x-schemaName: AdminAddClaimItems + properties: + items: + type: array + description: The item's details. + items: + type: object + description: An item's details. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The ID of the order's item. + quantity: + type: number + title: quantity + description: The quantity of the order's item to add to the claim. + reason: + type: string + description: The reason the item is claimed. + enum: + - missing_item + - wrong_item + - production_failure + - other + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: A note that's only viewed by admin users. + AdminAddClaimOutboundItems: + 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. AdminAddDraftOrderItems: type: object description: The details of the items to add to a draft order. @@ -9739,6 +9789,163 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata + AdminAddExchangeInboundItems: + type: object + description: The details of the inbound (return) items. + x-schemaName: AdminAddExchangeInboundItems + properties: + items: + type: array + description: The details of the inbound (return) items. + items: + type: object + description: An item's details. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The ID of the order's item. + 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. + reason_id: + type: string + title: reason_id + description: The ID of the return reason to associate with the item. + 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 + location_id: + type: string + title: location_id + description: The ID of the location to which outbound items are sent from. + AdminAddExchangeOutboundItems: + type: object + description: The details of outbound items. + x-schemaName: AdminAddExchangeOutboundItems + properties: + items: + type: array + description: The details of outbound items. + 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 item's quantity. + 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. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether the item can be added even if it's not in stock. + 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 + AdminAddReturnItem: + 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 + AdminAddReturnItems: + type: object + description: The items' details. + x-schemaName: AdminAddReturnItems + properties: + items: + type: array + description: The items' details. + items: + $ref: '#/components/schemas/AdminAddReturnItem' + required: + - items + AdminAddReturnShipping: + 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 AdminApiKey: type: object description: The API key's details. @@ -9885,6 +10092,25 @@ components: type: number title: apply_to_quantity description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `1`. + AdminBatchCreateInventoryItemLocationLevels: + type: object + description: The inventory level's details. + required: + - location_id + properties: + location_id: + type: string + title: location_id + description: The ID of the associated location. + stocked_quantity: + type: number + title: stocked_quantity + description: The inventory level's stocked quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The inventory level's incoming quantity. + x-schemaName: AdminBatchCreateInventoryItemLocationLevels AdminBatchCreateInventoryItemsLocationLevels: type: object description: The details of an inventory level to create. @@ -9909,6 +10135,47 @@ components: title: incoming_quantity description: The incoming quantity to be added to stock. x-schemaName: AdminBatchCreateInventoryItemsLocationLevels + AdminBatchImageVariantRequest: + 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. + AdminBatchImageVariantResponse: + 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. AdminBatchInventoryItemLocationsLevel: type: object description: The inventory levels to create, update, or delete. @@ -10023,6 +10290,25 @@ components: type: string title: deleted description: The ID of a deleted inventory level. + AdminBatchLink: + 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 AdminBatchProductRequest: type: object description: The products to create, update, or delete. @@ -10219,6 +10505,10 @@ components: type: string title: url description: The image's URL. + id: + type: string + title: id + description: The image's ID. thumbnail: type: string title: thumbnail @@ -10433,8 +10723,53 @@ components: type: string title: id description: The update's ID. + thumbnail: + type: string + title: thumbnail + description: The variant's thumbnail. required: - id + AdminBatchVariantImagesRequest: + 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. + AdminBatchVariantImagesResponse: + 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. AdminCampaign: type: object description: The campaign's details. @@ -10545,6 +10880,15 @@ components: properties: campaign: $ref: '#/components/schemas/AdminCampaign' + AdminCapturePayment: + type: object + description: The payment's details. + properties: + amount: + type: number + title: amount + description: The amount to capture. + x-schemaName: AdminCapturePayment AdminClaim: type: object description: The claim's details. @@ -10654,6 +10998,35 @@ components: format: date-time title: deleted_at description: The date the claim was deleted. + AdminClaimAddOutboundShipping: + type: object + description: The details of the shipping method used to ship outbound items. + x-schemaName: AdminClaimAddOutboundShipping + 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 a custom price for the shipping method. + description: + type: string + title: description + description: The shipping method's description. + 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 AdminClaimDeleteResponse: type: object description: The details of the deleted claim. @@ -10768,6 +11141,44 @@ components: $ref: '#/components/schemas/AdminOrderPreview' return: $ref: '#/components/schemas/AdminReturn' + AdminClaimUpdateInboundShipping: + type: object + description: The details to update in the shipping method. + x-schemaName: AdminClaimUpdateInboundShipping + 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 + AdminClaimUpdateOutboundShipping: + 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 AdminCollection: type: object description: The product collection's details. @@ -10997,6 +11408,24 @@ components: - timestamp - metric - relationship + AdminConfirmReceiveReturn: + type: object + description: The confirmation's details. + x-schemaName: AdminConfirmReceiveReturn + properties: + no_notification: + type: boolean + title: no_notification + description: Whether to send the customer a notification about the confirmation. + AdminConfirmReturnRequest: + 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. AdminCreateApiKey: type: object description: The API key's details. @@ -11068,6 +11497,42 @@ components: metadata: type: object description: The shipping option's metadata, can hold custom key-value pairs. + AdminCreateClaim: + type: object + description: The claim's details. + x-schemaName: AdminCreateClaim + required: + - type + - order_id + properties: + type: + type: string + description: The claim's type. + enum: + - refund + - replace + order_id: + type: string + title: order_id + description: The ID of the order the claim is created for. + description: + type: string + title: description + description: The claim's description. + 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 AdminCreateCustomerGroup: type: object description: The customer group's details. @@ -11085,6 +11550,31 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata + AdminCreateExchange: + type: object + description: The exchange's details. + x-schemaName: AdminCreateExchange + required: + - order_id + properties: + order_id: + type: string + title: order_id + description: The ID of the order this exchange is created for. + description: + type: string + title: description + description: The exchange'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 AdminCreateFlatRateShippingOption: type: object description: The flat rate shipping option's details. @@ -11237,14 +11727,12 @@ components: 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 @@ -11255,118 +11743,17 @@ components: 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: '#/components/schemas/AdminFulfillmentDeliveryAddress' 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: '#/components/schemas/AdminCreateFulfillmentItem' 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: '#/components/schemas/AdminCreateFulfillmentLabel' order_id: type: string title: order_id @@ -11407,11 +11794,67 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminCreateFulfillmentSetServiceZones: + AdminCreateFulfillmentItem: type: object - description: The service zone's details. + 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 + AdminCreateFulfillmentLabel: + 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 + AdminCreateFulfillmentSetServiceZone: + type: object + description: Details of the service zone to create for the fulfillment set. required: - name + - geo_zones properties: name: type: string @@ -11551,7 +11994,19 @@ components: postal_expression: type: object description: The geo zone's postal expression or ZIP code. - x-schemaName: AdminCreateFulfillmentSetServiceZones + x-schemaName: AdminCreateFulfillmentSetServiceZone + AdminCreateFulfillmentShipment: + 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: '#/components/schemas/AdminCreateFulfillmentLabel' AdminCreateGiftCardParams: type: object description: The details of the gift card to create. @@ -11670,29 +12125,10 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminCreateInventoryLocationLevel: - type: object - description: The inventory level's details. - required: - - location_id - properties: - location_id: - type: string - title: location_id - description: The ID of the associated location. - stocked_quantity: - type: number - title: stocked_quantity - description: The inventory level's stocked quantity. - incoming_quantity: - type: number - title: incoming_quantity - description: The inventory level's incoming quantity. - x-schemaName: AdminCreateInventoryLocationLevel - AdminCreateOrderCreditLines: + AdminCreateOrderCreditLine: type: object description: The details of a credit line to add to an order. - x-schemaName: AdminCreateOrderCreditLines + x-schemaName: AdminCreateOrderCreditLine required: - amount - reference @@ -11719,15 +12155,6 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminCreatePaymentCapture: - type: object - description: The payment's details. - properties: - amount: - type: number - title: amount - description: The amount to capture. - x-schemaName: AdminCreatePaymentCapture AdminCreatePaymentCollection: type: object description: The payment collection's details. @@ -11744,23 +12171,6 @@ components: title: amount description: The amount to be paid. x-schemaName: AdminCreatePaymentCollection - AdminCreatePaymentRefund: - type: object - description: The refund's details. - properties: - amount: - type: number - title: amount - description: The amount to refund. - refund_reason_id: - type: string - title: refund_reason_id - description: The ID of a refund reason. - note: - type: string - title: note - description: A note to attach to the refund. - x-schemaName: AdminCreatePaymentRefund AdminCreatePriceList: type: object description: The price list's details. @@ -11808,38 +12218,41 @@ components: 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: '#/components/schemas/AdminCreatePriceListPrice' + AdminCreatePriceListPrice: + 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 AdminCreatePricePreference: type: object description: The price preference's details. @@ -12459,36 +12872,6 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminCreateShipment: - 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. AdminCreateShippingOptionRule: type: object description: The details of the shipping option rule. @@ -12597,8 +12980,8 @@ components: type: object description: The fulfillment set to create. required: - - type - name + - type properties: name: type: string @@ -12769,8 +13152,8 @@ components: 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 @@ -13814,6 +14197,33 @@ components: type: boolean title: deleted description: Whether the object was deleted. + AdminDismissItems: + 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. AdminDraftOrder: type: object description: The draft order's details. @@ -13823,13 +14233,13 @@ components: - items - shipping_methods - status - - currency_code - id - version - region_id - customer_id - sales_channel_id - email + - currency_code - payment_status - fulfillment_status - summary @@ -14115,6 +14525,15 @@ components: title: estimate_count description: The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate. x-featureFlag: index_engine + AdminDraftOrderParams: + 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. AdminDraftOrderPreview: type: object description: The draft order preview's details. @@ -14123,13 +14542,13 @@ components: - 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 @@ -14889,6 +15308,35 @@ components: type: boolean title: allow_backorder description: Whether variants that are out-of-stock can still be added as additional or outbound items. + AdminExchangeAddOutboundShipping: + type: object + description: The outbound shipping method's details. + x-schemaName: AdminExchangeAddOutboundShipping + 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 a custom amount for 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 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 AdminExchangeDeleteResponse: type: object description: The details of deleting an exchange. @@ -14971,6 +15419,44 @@ components: $ref: '#/components/schemas/AdminOrderPreview' return: $ref: '#/components/schemas/AdminReturn' + AdminExchangeUpdateInboundShipping: + type: object + description: The details of the shipping method to update. + x-schemaName: AdminExchangeUpdateInboundShipping + 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 + AdminExchangeUpdateOutboundShipping: + 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 AdminExportProductResponse: type: object description: The details of the product export. @@ -15209,6 +15695,61 @@ components: format: date-time title: deleted_at description: The date the address was deleted. + AdminFulfillmentDeliveryAddress: + 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 AdminFulfillmentItem: type: object description: The details of a fulfillment's item. @@ -15759,6 +16300,83 @@ components: title: mime_type description: The file's mime type. example: text/csv + AdminIndexDetailsResponse: + type: object + description: The index's metadata details. + x-schemaName: AdminIndexDetailsResponse + required: + - metadata + properties: + metadata: + type: array + description: The index's metadata. + items: + $ref: '#/components/schemas/IndexInfo' + AdminIndexSyncPayload: + 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 + AdminInitiateReceiveReturn: + type: object + description: The return receival details. + x-schemaName: AdminInitiateReceiveReturn + properties: + internal_note: + type: string + title: internal_note + description: A note viewed only by admin users. + description: + type: string + title: description + description: The return's description. + metadata: + type: object + description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata + AdminInitiateReturnRequest: + type: object + description: The return's details. + x-schemaName: AdminInitiateReturnRequest + required: + - order_id + properties: + order_id: + type: string + title: order_id + description: The ID of the order the return belongs to. + location_id: + type: string + title: location_id + description: The ID of the location the items are returned to. + description: + type: string + title: description + description: The return's description. + internal_note: + type: string + title: internal_note + description: A note viewed only by admin users. + no_notification: + type: boolean + title: no_notification + description: Whether to send the customer a notification about the created return. + metadata: + type: object + description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminInventoryItem: type: object description: The inventory item's details. @@ -15998,7 +16616,7 @@ components: title: remove description: The ID of a product. x-schemaName: AdminLinkPriceListProducts - AdminMarkPaymentCollectionPaid: + AdminMarkPaymentCollectionAsPaid: type: object description: The payment details. required: @@ -16008,7 +16626,7 @@ components: type: string title: order_id description: The ID of the order associated with the payment collection. - x-schemaName: AdminMarkPaymentCollectionPaid + x-schemaName: AdminMarkPaymentCollectionAsPaid AdminNotification: type: object description: The notification's details. @@ -16126,13 +16744,13 @@ components: - items - shipping_methods - status - - currency_code - id - version - region_id - customer_id - sales_channel_id - email + - currency_code - payment_status - fulfillment_status - summary @@ -16483,7 +17101,6 @@ components: - created_at - updated_at - order_id - - canceled_at - return_id - exchange_id - claim_id @@ -16495,6 +17112,7 @@ components: - declined_reason - declined_at - canceled_by + - canceled_at properties: id: type: string @@ -17098,13 +17716,13 @@ components: - 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 @@ -18191,201 +18809,6 @@ components: type: boolean title: no_notification description: Whether to send the customer a notification about the return's cancelation. - AdminPostClaimItemsReqSchema: - type: object - description: The details of the order items to add to the claim. - x-schemaName: AdminPostClaimItemsReqSchema - properties: - items: - type: array - description: The item's details. - items: - type: object - description: An item's details. - required: - - id - - quantity - properties: - id: - type: string - title: id - description: The ID of the order's item. - quantity: - type: number - title: quantity - description: The quantity of the order's item to add to the claim. - reason: - type: string - description: The reason the item is claimed. - enum: - - missing_item - - wrong_item - - production_failure - - other - description: - type: string - title: description - description: The item's description. - internal_note: - type: string - title: internal_note - description: A note that's only viewed by admin users. - AdminPostClaimsAddItemsReqSchema: - 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 - AdminPostClaimsItemsActionReqSchema: - type: object - description: The details to update in the item. - x-schemaName: AdminPostClaimsItemsActionReqSchema - 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. - AdminPostClaimsShippingActionReqSchema: - type: object - description: The details to update in the shipping method. - x-schemaName: AdminPostClaimsShippingActionReqSchema - 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 - AdminPostClaimsShippingReqSchema: - type: object - description: The details of the shipping method used to ship outbound items. - x-schemaName: AdminPostClaimsShippingReqSchema - 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 a custom price for the shipping method. - description: - type: string - title: description - description: The shipping method's description. - 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 - AdminPostExchangesAddItemsReqSchema: - type: object - description: The details of outbound items. - x-schemaName: AdminPostExchangesAddItemsReqSchema - properties: - items: - type: array - description: The details of outbound items. - 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 item's quantity. - 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. - allow_backorder: - type: boolean - title: allow_backorder - description: Whether the item can be added even if it's not in stock. - 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 - AdminPostExchangesItemsActionReqSchema: - type: object - description: The details to update in an outbound item. - x-schemaName: AdminPostExchangesItemsActionReqSchema - properties: - quantity: - type: number - title: quantity - description: The item's quantity. - internal_note: - type: string - title: internal_note - description: A note only viewed by admin users. AdminPostExchangesRequestItemsReturnActionReqSchema: type: object description: The details to update in an inbound (returned) item. @@ -18409,135 +18832,6 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminPostExchangesReturnRequestItemsReqSchema: - type: object - description: The details of the inbound (return) items. - x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema - properties: - items: - type: array - description: The details of the inbound (return) items. - items: - type: object - description: An item's details. - required: - - id - - quantity - properties: - id: - type: string - title: id - description: The ID of the order's item. - 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. - reason_id: - type: string - title: reason_id - description: The ID of the return reason to associate with the item. - 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 - location_id: - type: string - title: location_id - description: The ID of the location to which outbound items are sent from. - AdminPostExchangesShippingActionReqSchema: - type: object - description: The details of the shipping method to update. - x-schemaName: AdminPostExchangesShippingActionReqSchema - 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 - AdminPostExchangesShippingReqSchema: - type: object - description: The outbound shipping method's details. - x-schemaName: AdminPostExchangesShippingReqSchema - 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 a custom amount for 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 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 - AdminPostOrderClaimsReqSchema: - type: object - description: The claim's details. - x-schemaName: AdminPostOrderClaimsReqSchema - required: - - type - - order_id - properties: - type: - type: string - description: The claim's type. - enum: - - refund - - replace - order_id: - type: string - title: order_id - description: The ID of the order the claim is created for. - description: - type: string - title: description - description: The claim's description. - 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 AdminPostOrderEditsAddItemsReqSchema: type: object description: The details of items to be edited. @@ -18700,59 +18994,6 @@ components: type: number title: compare_at_unit_price description: The original price of the item before a promotion or sale. - AdminPostOrderExchangesReqSchema: - type: object - description: The exchange's details. - x-schemaName: AdminPostOrderExchangesReqSchema - required: - - order_id - properties: - order_id: - type: string - title: order_id - description: The ID of the order this exchange is created for. - description: - type: string - title: description - description: The exchange'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 - AdminPostReceiveReturnsReqSchema: - type: object - description: The return receival details. - x-schemaName: AdminPostReceiveReturnsReqSchema - properties: - internal_note: - type: string - title: internal_note - description: A note viewed only by admin users. - description: - type: string - title: description - description: The return's description. - metadata: - type: object - description: The return's metadata, can hold custom key-value pairs. - externalDocs: - url: https://docs.medusajs.com/api/admin#manage-metadata - description: Learn how to manage metadata - AdminPostReturnsConfirmRequestReqSchema: - type: object - description: The confirmation's details. - x-schemaName: AdminPostReturnsConfirmRequestReqSchema - properties: - no_notification: - type: boolean - title: no_notification - description: Whether to send the customer a notification about the confirmation. AdminPostReturnsDismissItemsActionReqSchema: type: object description: The details to update of the damaged item. @@ -18779,70 +19020,6 @@ components: type: string title: internal_note description: A note viewed only by admin users. - AdminPostReturnsReceiveItemsReqSchema: - type: object - description: The items details. - x-schemaName: AdminPostReturnsReceiveItemsReqSchema - 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. - 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. - AdminPostReturnsReqSchema: - type: object - description: The return's details. - x-schemaName: AdminPostReturnsReqSchema - required: - - order_id - properties: - order_id: - type: string - title: order_id - description: The ID of the order the return belongs to. - location_id: - type: string - title: location_id - description: The ID of the location the items are returned to. - description: - type: string - title: description - description: The return's description. - internal_note: - type: string - title: internal_note - description: A note viewed only by admin users. - no_notification: - type: boolean - title: no_notification - description: Whether to send the customer a notification about the created return. - metadata: - type: object - description: The return's metadata, can hold custom key-value pairs. - externalDocs: - url: https://docs.medusajs.com/api/admin#manage-metadata - description: Learn how to manage metadata AdminPostReturnsRequestItemsActionReqSchema: type: object description: The details to update in the item. @@ -18907,44 +19084,6 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminPostReturnsReturnReqSchema: - type: object - description: The return's details. - x-schemaName: AdminPostReturnsReturnReqSchema - properties: - location_id: - type: string - title: location_id - description: The ID of the location to return items to. - no_notification: - type: boolean - title: no_notification - description: Whether the customer should receive notifications about updates to the return. - metadata: - type: object - description: The return's metadata, can hold custom key-value pairs. - externalDocs: - url: https://docs.medusajs.com/api/admin#manage-metadata - description: Learn how to manage metadata - AdminPostReturnsShippingActionReqSchema: - type: object - description: The shipping method's details. - x-schemaName: AdminPostReturnsShippingActionReqSchema - properties: - custom_amount: - type: number - title: custom_amount - description: Set a custom price for the shipping method. - internal_note: - type: string - title: internal_note - description: A note viewed only by admin users. - metadata: - type: object - description: The return's metadata, can hold custom key-value pairs. - externalDocs: - url: https://docs.medusajs.com/api/admin#manage-metadata - description: Learn how to manage metadata AdminPostReturnsShippingReqSchema: type: object description: The shipping method's details. @@ -19411,13 +19550,13 @@ components: - length - title - status - - description - id - created_at - updated_at - subtitle - thumbnail - handle + - description - is_giftcard - width - weight @@ -19780,6 +19919,13 @@ components: 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 @@ -20134,6 +20280,7 @@ components: - barcode - ean - upc + - thumbnail - allow_backorder - manage_inventory - hs_code @@ -20264,6 +20411,15 @@ components: description: The variant's inventory items. items: $ref: '#/components/schemas/AdminProductVariantInventoryItemLink' + images: + type: array + description: The variant's images. + items: + $ref: '#/components/schemas/AdminProductImage' + thumbnail: + type: string + title: thumbnail + description: The variant's thumbnail. AdminProductVariantDeleteResponse: type: object description: The details of the product variant's deletion. @@ -20601,6 +20757,37 @@ components: - cusgroup_123 items: $ref: '#/components/schemas/BasePromotionRuleValue' + AdminReceiveItems: + type: object + description: The items details. + x-schemaName: AdminReceiveItems + 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. + 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. AdminRedeemGiftCard: type: object description: The details of the gift card to redeem. @@ -20651,6 +20838,23 @@ components: $ref: '#/components/schemas/BasePayment' refund_reason: $ref: '#/components/schemas/BaseRefundReason' + AdminRefundPayment: + type: object + description: The refund's details. + properties: + amount: + type: number + title: amount + description: The amount to refund. + refund_reason_id: + type: string + title: refund_reason_id + description: The ID of a refund reason. + note: + type: string + title: note + description: A note to attach to the refund. + x-schemaName: AdminRefundPayment AdminRefundReason: type: object description: The refund reason's details. @@ -20721,9 +20925,9 @@ components: description: The region's details. x-schemaName: AdminRegion required: - - name - - currency_code - id + - currency_code + - name properties: id: type: string @@ -20825,6 +21029,25 @@ components: type: string title: promo_codes description: A promotion code to remove from the draft order. + AdminRequestOrderTransfer: + type: object + description: The details of the request to transfer the order. + x-schemaName: AdminRequestOrderTransfer + required: + - customer_id + properties: + customer_id: + type: string + title: customer_id + description: The ID of the customer to transfer the order to. + description: + type: string + title: description + description: The description of the order transfer, which can be shown to the customer receiving the order transfer request. + internal_note: + type: string + title: internal_note + description: An internal note viewable only by admin users. AdminReservation: type: object description: The reservation's details. @@ -22756,25 +22979,6 @@ components: title: estimate_count description: The store credit account's estimate count. x-featureFlag: index_engine - AdminTransferOrder: - type: object - description: The details of the request to transfer the order. - x-schemaName: AdminTransferOrder - required: - - customer_id - properties: - customer_id: - type: string - title: customer_id - description: The ID of the customer to transfer the order to. - description: - type: string - title: description - description: The description of the order transfer, which can be shown to the customer receiving the order transfer request. - internal_note: - type: string - title: internal_note - description: An internal note viewable only by admin users. AdminUpdateApiKey: type: object description: The details to update in an API key. @@ -22786,6 +22990,40 @@ components: type: string title: title description: The API key's title. + AdminUpdateClaimItem: + type: object + description: The details to update in the item. + x-schemaName: AdminUpdateClaimItem + 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. + AdminUpdateClaimOutboundItem: + 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. AdminUpdateCustomerGroup: type: object description: The details to update in a customer group. @@ -22812,115 +23050,9 @@ components: 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: '#/components/schemas/OrderAddress' 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: '#/components/schemas/OrderAddress' metadata: type: object description: The draft order's metadata, can hold custom key-value pairs. @@ -23004,7 +23136,20 @@ components: type: string title: internal_note description: A note viewed only by admin users about the shipping method. - AdminUpdateFulfillmentSetServiceZones: + AdminUpdateExchangeOutboundItem: + type: object + description: The details to update in an outbound item. + x-schemaName: AdminUpdateExchangeOutboundItem + properties: + quantity: + type: number + title: quantity + description: The item's quantity. + internal_note: + type: string + title: internal_note + description: A note only viewed by admin users. + AdminUpdateFulfillmentSetServiceZone: type: object description: The service zone's details. properties: @@ -23162,7 +23307,7 @@ components: type: string title: id description: The ID of an existing geo zone. - x-schemaName: AdminUpdateFulfillmentSetServiceZones + x-schemaName: AdminUpdateFulfillmentSetServiceZone AdminUpdateGiftCardParams: type: object description: The details to update in the gift card. @@ -23264,7 +23409,7 @@ components: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata x-schemaName: AdminUpdateInventoryItem - AdminUpdateInventoryLocationLevel: + AdminUpdateInventoryLevel: type: object description: The properties to update in the inventory level. properties: @@ -23276,7 +23421,7 @@ components: type: number title: incoming_quantity description: The inventory level's incoming quantity. - x-schemaName: AdminUpdateInventoryLocationLevel + x-schemaName: AdminUpdateInventoryLevel AdminUpdateOrder: type: object description: The details to update in the order. @@ -23288,138 +23433,15 @@ components: 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: '#/components/schemas/OrderAddress' 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: '#/components/schemas/OrderAddress' metadata: type: object description: The order's metadata, can hold custom key-value pairs. externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata - AdminUpdatePaymentRefundReason: - type: object - description: The properties to update in the refund reason. - properties: - label: - type: string - title: label - description: The refund reason's label. - description: - type: string - title: description - description: The refund reason's description. - code: - type: string - title: code - description: The refund reason's code. - x-schemaName: AdminUpdatePaymentRefundReason AdminUpdatePriceList: type: object description: the details to update in a price list. @@ -23846,6 +23868,29 @@ components: description: An attribute value. example: prod_123 x-schemaName: AdminUpdatePromotionRule + AdminUpdateRefundReason: + type: object + description: The properties to update in the refund reason. + properties: + label: + type: string + title: label + description: The refund reason's label. + description: + type: string + title: description + description: The refund reason's description. + code: + type: string + title: code + description: The refund reason's code. + metadata: + type: object + description: The refund reason's metadata. + x-schemaName: AdminUpdateRefundReason + required: + - label + - code AdminUpdateRegion: type: object description: The propeties to update in the region. @@ -23910,6 +23955,29 @@ components: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata x-schemaName: AdminUpdateReservation + AdminUpdateReturnItems: + 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 AdminUpdateReturnReason: type: object description: The details to update in a return reason. @@ -23936,6 +24004,44 @@ components: required: - value - label + AdminUpdateReturnRequest: + type: object + description: The return's details. + x-schemaName: AdminUpdateReturnRequest + properties: + location_id: + type: string + title: location_id + description: The ID of the location to return items to. + no_notification: + type: boolean + title: no_notification + description: Whether the customer should receive notifications about updates to the return. + metadata: + type: object + description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata + AdminUpdateReturnShipping: + type: object + description: The shipping method's details. + x-schemaName: AdminUpdateReturnShipping + properties: + custom_amount: + type: number + title: custom_amount + description: Set a custom price for the shipping method. + internal_note: + type: string + title: internal_note + description: A note viewed only by admin users. + metadata: + type: object + description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateSalesChannel: type: object description: The properties to update in the sales channel. @@ -23959,6 +24065,216 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata + AdminUpdateShippingOption: + 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: '#/components/schemas/AdminCreateShippingOptionType' + 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 AdminUpdateShippingOptionRule: type: object description: The properties to update in the shipping option rule. @@ -24049,49 +24365,7 @@ components: 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: '#/components/schemas/AdminUpsertStockLocationAddress' address_id: type: string title: address_id @@ -24115,24 +24389,7 @@ components: 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: '#/components/schemas/AdminUpdateStoreSupportedCurrency' default_sales_channel_id: type: string title: default_sales_channel_id @@ -24151,6 +24408,26 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata + AdminUpdateStoreSupportedCurrency: + 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 AdminUpdateTaxRate: type: object description: The properties to update in the tax rate. @@ -24168,22 +24445,7 @@ components: 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: '#/components/schemas/AdminCreateTaxRateRule' name: type: string title: name @@ -24204,6 +24466,8 @@ components: externalDocs: url: https://docs.medusajs.com/api/admin#manage-metadata description: Learn how to manage metadata + required: + - code AdminUpdateTaxRegion: type: object description: The details to update in a tax region. @@ -27777,6 +28041,7 @@ components: - barcode - ean - upc + - thumbnail - allow_backorder - manage_inventory - hs_code @@ -27898,6 +28163,10 @@ components: 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. BasePromotionRuleValue: type: object description: The rule value's details. @@ -28769,6 +29038,50 @@ components: - unexpected_state - invalid_argument - unknown_error + IndexInfo: + 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. InventoryLevel: type: object description: The inventory level's details @@ -30798,8 +31111,8 @@ components: x-schemaName: StoreCart required: - promotions - - currency_code - id + - currency_code - original_item_total - original_item_subtotal - original_item_tax_total @@ -32412,10 +32725,10 @@ components: properties: customer: $ref: '#/components/schemas/StoreCustomer' - StoreDeclineOrderTransferRequest: + StoreDeclineOrderTransfer: type: object description: The details of declining the order transfer request. - x-schemaName: StoreDeclineOrderTransferRequest + x-schemaName: StoreDeclineOrderTransfer required: - token properties: @@ -32536,12 +32849,12 @@ components: - items - shipping_methods - status - - currency_code - id - region_id - customer_id - sales_channel_id - email + - currency_code - payment_status - fulfillment_status - summary @@ -39689,6 +40002,10 @@ components: description: The variant's rank among its siblings. calculated_price: $ref: '#/components/schemas/BaseCalculatedPriceSet' + thumbnail: + type: string + title: thumbnail + description: The variant's thumbnail. required: - options - length @@ -39696,6 +40013,7 @@ components: - id - created_at - updated_at + - thumbnail - width - weight - height @@ -39704,12 +40022,12 @@ components: - mid_code - material - deleted_at - - sku - - barcode - manage_inventory - allow_backorder - ean - upc + - barcode + - sku StoreRegion: type: object description: The region's details. diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml index 908ce119d4..7e696d23a4 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml @@ -20,65 +20,6 @@ get: type: string externalDocs: url: https://docs.medusajs.com/api/store#publishable-api-key - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. This API route restricts the fields - that can be selected. Learn how to override the retrievable fields in - the [Retrieve Custom - Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) - documentation. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. This API route - restricts the fields that can be selected. Learn how to override the - retrievable fields in the [Retrieve Custom - Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) - documentation. - externalDocs: - url: '#select-fields-and-relations' - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - externalDocs: - url: '#pagination' - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - externalDocs: - url: '#pagination' - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - name: city in: query description: Filter by the address's city. @@ -132,14 +73,62 @@ get: type: string title: q description: Search term to filter the address's searchable properties. - - name: with_deleted + - name: company in: query - description: Whether to include deleted records in the result. required: false schema: - type: boolean - title: with_deleted - description: Whether to include deleted records in the result. + oneOf: + - type: string + title: company + description: Filter addresses by company. + - type: array + description: Filter addresses by companies. + items: + type: string + title: company + description: A company. + - name: province + in: query + required: false + schema: + oneOf: + - type: string + title: province + description: Filter addresses by province. + - type: array + description: Filter addresses by provinces. + items: + type: string + title: province + description: A province. + - 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: - cookie_auth: [] - jwt_token: [] diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml index 664381d834..dd474a4704 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml @@ -46,7 +46,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/StoreDeclineOrderTransferRequest.yaml + $ref: ../components/schemas/StoreDeclineOrderTransfer.yaml x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml index 54b4e1d9bb..0c9e7b537b 100644 --- a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml @@ -102,41 +102,6 @@ get: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - externalDocs: - url: '#pagination' - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - externalDocs: - url: '#pagination' - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - externalDocs: - url: '#pagination' x-codeSamples: - lang: JavaScript label: JS SDK diff --git a/www/utils/generated/oas-output/base/admin.oas.base.yaml b/www/utils/generated/oas-output/base/admin.oas.base.yaml index e39ed340aa..4acb4c7fc9 100644 --- a/www/utils/generated/oas-output/base/admin.oas.base.yaml +++ b/www/utils/generated/oas-output/base/admin.oas.base.yaml @@ -181,6 +181,12 @@ tags: x-associatedSchema: $ref: "#/components/schemas/AdminGiftCard" + - 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 description: | An inventory item is a stock-kept product whose inventory is managed. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts index 6bfc996bd4..3bdbd7c815 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts @@ -53,6 +53,55 @@ * type: boolean * title: with_deleted * 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: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts index 60726c3031..5a290fdda7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts @@ -47,11 +47,11 @@ * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: deleted_at * in: query - * description: The claim's deleted at. + * description: Filter by the claim's deletion date. * required: false * schema: * type: object - * description: The claim's deleted at. + * description: The claim's deletion date. * properties: * $and: * type: array @@ -319,20 +319,20 @@ * oneOf: * - type: string * title: status - * description: The claim's status. + * description: Filter by the claim's status. * - type: array - * description: The claim's status. + * description: Filter by the claim's status. * items: * type: string * title: status - * description: The status's details. + * description: The claim's status. * - name: created_at * in: query - * description: The claim's created at. + * description: Filter by the claim's creation date. * required: false * schema: * type: object - * description: The claim's created at. + * description: The claim's creation date. * properties: * $and: * type: array @@ -559,11 +559,11 @@ * description: Filter by whether a value for this parameter exists (not `null`). * - name: updated_at * in: query - * description: The claim's updated at. + * description: Filter by the claim's update date. * required: false * schema: * type: object - * description: The claim's updated at. + * description: The claim's update date. * properties: * $and: * type: array diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_index_details.ts b/www/utils/generated/oas-output/operations/admin/get_admin_index_details.ts new file mode 100644 index 0000000000..bf401d789c --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_index_details.ts @@ -0,0 +1,43 @@ +/** + * @oas [get] /admin/index/details + * operationId: GetIndexDetails + * summary: Get Index Details + * description: Retrieve index metadata, including entity type, status, last synced key, and last updated timestamp. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/index/details' \ + * -H 'Authorization: Bearer {access_token}' + * tags: + * - Index + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminIndexDetailsResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-since: 2.11.2 + * x-featureFlag: index + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts index aabbb09f32..4b0d5ece0e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts @@ -51,24 +51,6 @@ * type: string * title: order * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * - name: $and - * in: query - * 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 - * required: false - * schema: - * type: array - * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $or * - name: with_deleted * in: query * description: Whether to include deleted records in the result. @@ -77,6 +59,20 @@ * type: boolean * title: with_deleted * description: Whether to include deleted records in the result. + * - name: location_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: location_id + * description: Filter by the inventory item's location ID. + * - type: array + * description: The inventory item's location IDs. + * items: + * type: string + * title: location_id + * description: The location ID. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts index eec1eb03ab..052d2adeb1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts @@ -23,34 +23,6 @@ * fields. without prefix it will replace the entire default fields. * externalDocs: * url: "#select-fields-and-relations" - * - name: id - * in: query - * required: false - * schema: - * oneOf: - * - type: string - * title: id - * description: The order's ID. - * - type: array - * description: The order's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * - name: status - * in: query - * required: false - * schema: - * oneOf: - * - type: string - * title: status - * description: The order's status. - * - type: array - * description: The order's status. - * items: - * type: string - * title: status - * description: The status's details. * - name: version * in: query * description: The order's version. @@ -59,18 +31,6 @@ * type: number * title: version * description: The order's version. - * - name: created_at - * in: query - * required: false - * schema: {} - * - name: updated_at - * in: query - * required: false - * schema: {} - * - name: deleted_at - * in: query - * required: false - * schema: {} * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts index 5f839d8533..438b6da8ee 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts @@ -6,7 +6,7 @@ * description: | * Retrieve a list of changes made on an order, including returns, exchanges, etc... * - * The changes can be filtered by fields like FILTER FIELDS. The changes can also be paginated. + * The changes can be filtered by fields like `created_at`. The changes can also be paginated. * x-authenticated: true * parameters: * - name: id @@ -29,6 +29,806 @@ * 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. + * - name: created_at + * in: query + * description: Filter by the order change's creation date. + * required: false + * schema: + * type: object + * description: Filter by the order change's creation date. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: An exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value not to match. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: The value to match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not matching this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value to not match + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the values of this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The value to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - type: array + * description: Filter by values not matching those in this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The values to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - name: updated_at + * in: query + * description: Filter by the order change's update date. + * required: false + * schema: + * type: object + * description: Filter by the order change's update date. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: An exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value not to match. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: The value to match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not matching this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value to not match + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the values of this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The value to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - type: array + * description: Filter by values not matching those in this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The values to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - name: deleted_at + * in: query + * description: Filter by the order change's deletion date. + * required: false + * schema: + * type: object + * description: Filter by the order change'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 multiple exact matches. + * items: + * type: string + * title: $eq + * description: An exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value not to match. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: The value to match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not matching this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value to not match + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the values of this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The value to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - type: array + * description: Filter by values not matching those in this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The values to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: Filter by an order change ID. + * - type: array + * description: Filter by order change IDs. + * items: + * type: string + * title: id + * description: An order change ID. + * - type: object + * description: The order's ID. + * 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 + * - name: status + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: status + * description: Filter by the order change's status. + * - type: array + * description: Filter by multiple order change statuses. + * items: + * type: string + * title: status + * description: An order change status. + * - type: object + * description: The order change's status. + * 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 + * - name: change_type + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: change_type + * description: Filter by the order change's type. + * - type: array + * description: Filter by multiple order change types. + * items: + * type: string + * title: change_type + * description: An order change type. + * - type: object + * description: Filter the order change's type. + * 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 + * - 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: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_line-items.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_line-items.ts index f650f5caea..923a874ff5 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_line-items.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_line-items.ts @@ -67,36 +67,6 @@ * type: number * title: version * description: The version's details. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * externalDocs: - * url: "#pagination" - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * externalDocs: - * url: "#pagination" - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * externalDocs: - * url: "#pagination" * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts index 42dfad241b..96522c119e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts @@ -47,6 +47,851 @@ * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, * `fields=category_children.id,category_children.name`. + * - name: is_internal + * in: query + * description: Filter by whether the product category is internal. + * required: false + * schema: + * type: boolean + * title: is_internal + * description: Filter by whether the product category is internal. + * - name: is_active + * in: query + * description: Filter by whether the product category is active. + * required: false + * schema: + * type: boolean + * title: is_active + * description: Filter by whether the product category is active. + * - name: q + * in: query + * description: Apply a search query to the product category's searchable properties. + * required: false + * schema: + * type: string + * title: q + * description: Apply a search query to the product category's searchable properties. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: Filter by the product category's ID. + * - type: array + * description: Filter by product category IDs. + * items: + * type: string + * title: id + * description: A product category ID. + * - name: name + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: name + * description: Filter by the product category's name. + * - type: array + * description: Filter by product category names. + * items: + * type: string + * title: name + * description: A product category name. + * - name: description + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: description + * description: Filter by the product category's description. + * - type: array + * description: Filter by product category descriptions. + * items: + * type: string + * title: description + * description: A product category description. + * - name: parent_category_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: parent_category_id + * description: Retrieve the categories of a given parent category's ID. + * - type: array + * description: Retrieve the categories of the given parent category IDs. + * items: + * type: string + * title: parent_category_id + * description: A parent category ID. + * - name: handle + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: handle + * description: Filter by the product category's handle. + * - type: array + * description: Filter by product category handles. + * items: + * type: string + * title: handle + * description: A product category handle. + * - name: created_at + * in: query + * description: Filter by the category's creation date. + * required: false + * schema: + * type: object + * description: Filter by the category's creation date. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: An exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value not to match. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: The value to match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not matching this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value to not match + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the values of this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The value to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - type: array + * description: Filter by values not matching those in this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The values to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - name: updated_at + * in: query + * description: Filter by the category's update date. + * required: false + * schema: + * type: object + * description: Filter by the category's update date. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: An exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value not to match. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: The value to match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not matching this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value to not match + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the values of this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The value to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - type: array + * description: Filter by values not matching those in this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The values to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - name: deleted_at + * in: query + * description: Filter by the category's deletion date. + * required: false + * schema: + * type: object + * description: Filter by the category'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 multiple exact matches. + * items: + * type: string + * title: $eq + * description: An exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value not to match. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: The value to match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not matching this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value to not match + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the values of this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The value to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - type: array + * description: Filter by values not matching those in this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The values to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * externalDocs: + * url: "#pagination" + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * externalDocs: + * url: "#pagination" + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * externalDocs: + * url: "#pagination" + * - name: with_deleted + * in: query + * description: The product category's with deleted. + * required: false + * schema: + * type: boolean + * title: with_deleted + * description: The product category's with deleted. + * - 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: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts index cbeeb4fc39..33f1be0a75 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts @@ -724,7 +724,7 @@ * description: Filter by whether a value for this parameter exists (not `null`). * updated_at: * type: object - * description: The variant's updated at. + * description: Filter by the variant's update date. * properties: * $and: * type: array @@ -985,35 +985,47 @@ * oneOf: * - type: string * title: ean - * description: The variant's ean. + * description: Filter by a variant's ean. * - type: array - * description: The variant's ean. + * description: Filter by variant eans. * items: * type: string * title: ean - * description: The ean's details. + * description: A variant's ean. * upc: * oneOf: * - type: string * title: upc - * description: The variant's upc. + * description: Filter by a variant's upc. * - type: array - * description: The variant's upc. + * description: Filter by variant upcs. * items: * type: string * title: upc - * description: The upc's details. + * description: A variant's upc. * barcode: * oneOf: * - type: string * title: barcode - * description: The variant's barcode. + * description: Filter by a variant's barcode. * - type: array - * description: The variant's barcode. + * description: Filter by variant barcodes. * items: * type: string * title: barcode - * description: The barcode's details. + * description: A variant's barcode. + * with_deleted: + * type: boolean + * title: with_deleted + * description: Whether to include deleted variants. + * - name: with_deleted + * in: query + * description: Whether to include deleted products. + * required: false + * schema: + * type: boolean + * title: with_deleted + * description: Whether to include deleted products. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts index ad70375a6f..158559017f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts @@ -38,6 +38,37 @@ * fields. without prefix it will replace the entire default fields. * externalDocs: * url: "#select-fields-and-relations" + * - name: promotion_type + * in: query + * description: The type + * required: false + * schema: + * type: string + * description: The promotion's type. + * enum: + * - standard + * - buyget + * - name: application_method_type + * in: query + * description: The promotion's application method type. + * required: false + * schema: + * type: string + * description: The promotion's application method type. + * enum: + * - fixed + * - percentage + * - name: application_method_target_type + * in: query + * description: The promotion's application method target type. + * required: false + * schema: + * type: string + * description: The promotion's application method target type. + * enum: + * - items + * - shipping_methods + * - order * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts index 8852c92e33..562135884b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts @@ -52,28 +52,6 @@ * type: string * title: order * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * - name: promotion_type - * in: query - * description: The promotion type to retrieve rules for. - * required: false - * schema: - * type: string - * title: promotion_type - * description: The promotion type to retrieve rules for. - * enum: - * - standard - * - buyget - * - name: application_method_type - * in: query - * description: The application method type to retrieve rules for. - * required: false - * schema: - * type: string - * title: application_method_type - * description: The application method type to retrieve rules for. - * enum: - * - fixed - * - percentage * - name: with_deleted * in: query * description: Whether to include deleted records in the result. @@ -88,8 +66,41 @@ * required: false * schema: * type: string - * title: application_method_target_type * description: The application method target type to retrieve rules for. + * - name: q + * in: query + * description: Apply a search query on the rule values' searchable properties. + * required: false + * schema: + * type: string + * title: q + * description: Apply a search query on the rule values' searchable properties. + * - name: value + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: value + * description: Filter by a specific rule value. + * - type: array + * description: Filter by multiple rule values. + * items: + * type: string + * title: value + * description: A rule value. + * - name: fields + * in: query + * description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. Without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. Without prefix it will replace the entire default fields. + * externalDocs: + * url: "#select-fields-and-relations" * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts index a12411e7aa..68e3897ebc 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts @@ -519,20 +519,133 @@ * type: boolean * title: with_deleted * description: Whether to include deleted records in the result. - * - name: order_id + * - name: q * in: query + * description: Apply a search query on the reservation's searchable properties. * required: false * schema: - * oneOf: - * - type: string - * title: order_id - * description: Filter by an order's ID to retrieve its associated reservations. - * - type: array - * description: Filter by multiple order IDs to retrieve their associated reservations. + * type: string + * title: q + * description: Apply a search query on the reservation's searchable properties. + * - name: quantity + * in: query + * description: Filter by the reservation's quantity. + * required: false + * schema: + * type: object + * description: Filter by a reservation's quantity. + * 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: order_id - * description: An order's ID. + * 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: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts index e6900d4c5a..233127d20d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts @@ -23,30 +23,6 @@ * fields. without prefix it will replace the entire default fields. * externalDocs: * url: "#select-fields-and-relations" - * - name: province_code - * in: query - * description: Filter by a tax region's province code. - * required: false - * schema: - * type: string - * title: province_code - * description: Filter by a tax region's province code. - * - name: provider_id - * in: query - * description: Filter by a tax provider ID to retrieve the tax regions using it. - * required: false - * schema: - * type: string - * title: provider_id - * description: Filter by a tax provider ID to retrieve the tax regions using it. - * - name: metadata - * in: query - * description: Filter by a tax region's metadata. Refer to the [Object Query Parameter](https://docs.medusajs.com/api/admin#object) section to learn how to filter by object fields. - * required: false - * schema: - * type: object - * description: Filter by a tax region's metadata. Refer to the [Object Query Parameter](https://docs.medusajs.com/api/admin#object) section to learn how to filter by object fields. - * title: metadata * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts index a1ca7ecaf1..c1744b8aaf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts @@ -32,23 +32,7 @@ * content: * application/json: * schema: - * type: object - * 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. + * $ref: "#/components/schemas/AdminBatchLink" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts index 59976bb137..e6063adaca 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts @@ -32,23 +32,7 @@ * content: * application/json: * schema: - * type: object - * 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. + * $ref: "#/components/schemas/AdminBatchLink" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts index 4d64c1044d..3075eabe87 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts @@ -17,6 +17,391 @@ * fields. without prefix it will replace the entire default fields. * externalDocs: * 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: * - api_token: [] * - cookie_auth: [] @@ -25,7 +410,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostOrderClaimsReqSchema" + * $ref: "#/components/schemas/AdminCreateClaim" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts index b319ca85c4..8619624afd 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostClaimItemsReqSchema" + * $ref: "#/components/schemas/AdminAddClaimItems" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts index 756ec95404..ef0a9c951b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts @@ -40,7 +40,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostClaimsItemsActionReqSchema" + * $ref: "#/components/schemas/AdminUpdateClaimItem" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts index 9c35128a9b..0f74d75d80 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -41,7 +41,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostClaimsShippingActionReqSchema" + * $ref: "#/components/schemas/AdminClaimUpdateInboundShipping" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts index dd7d33ed22..9e923be522 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts @@ -33,7 +33,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostClaimsAddItemsReqSchema" + * $ref: "#/components/schemas/AdminAddClaimOutboundItems" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts index 443d115012..6c7f078459 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts @@ -41,7 +41,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostClaimsItemsActionReqSchema" + * $ref: "#/components/schemas/AdminUpdateClaimOutboundItem" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts index 073963eb50..fbac3741e6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts @@ -33,7 +33,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostClaimsShippingReqSchema" + * $ref: "#/components/schemas/AdminClaimAddOutboundShipping" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts index dbdd79a60a..6be7f97012 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -41,7 +41,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostClaimsShippingActionReqSchema" + * $ref: "#/components/schemas/AdminClaimUpdateOutboundShipping" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts index 45ef1b7fe1..1ee56a224a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts @@ -32,23 +32,7 @@ * content: * application/json: * schema: - * type: object - * description: The products to add or remove. - * properties: - * add: - * type: array - * description: The products to add to the collection. - * items: - * type: string - * title: add - * description: A product's ID. - * remove: - * type: array - * description: The products to remove from the collection. - * items: - * type: string - * title: remove - * description: A product's ID. + * $ref: "#/components/schemas/AdminBatchLink" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts index 2aaa997ee7..ce6635dccf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts @@ -32,23 +32,7 @@ * content: * application/json: * schema: - * type: object - * description: The customers to add or remove from the group. - * properties: - * add: - * type: array - * description: The customers to add to the group. - * items: - * type: string - * title: add - * description: A customer's ID. - * remove: - * type: array - * description: The customers to remove from the group. - * items: - * type: string - * title: remove - * description: A customer's ID. + * $ref: "#/components/schemas/AdminBatchLink" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts index 25cb4885b0..c47e436e9a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts @@ -36,23 +36,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * properties: - * add: - * type: array - * description: The customer groups to add the customer to. - * items: - * type: string - * title: add - * description: The ID of the group to add the customer to. - * remove: - * type: array - * description: The customer groups to remove the customer from. - * items: - * type: string - * title: remove - * description: The ID of the group to remove the customer from. + * $ref: "#/components/schemas/AdminBatchLink" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts index 0aaec1a479..cfeae95b31 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts @@ -12,20 +12,6 @@ * required: true * schema: * type: string - * - name: fields - * in: query - * description: |- - * Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. Without prefix it will replace the entire default fields. - * externalDocs: - * url: "#select-fields-and-relations" * security: * - api_token: [] * - cookie_auth: [] @@ -58,6 +44,10 @@ * responses: * "200": * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -83,6 +73,11 @@ * Emitted when an order is placed, or when a draft order is converted to an * order. * deprecated: false + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminDraftOrderParams" * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts index d46d52c4bb..e3e5e18aad 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts @@ -25,7 +25,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostOrderExchangesReqSchema" + * $ref: "#/components/schemas/AdminCreateExchange" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts index 1828068b7b..7ba2100a5b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts @@ -12,6 +12,18 @@ * required: true * schema: * type: string + * - name: fields + * in: query + * description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. Without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. Without prefix it will replace the entire default fields. + * externalDocs: + * url: "#select-fields-and-relations" * security: * - api_token: [] * - cookie_auth: [] @@ -20,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema" + * $ref: "#/components/schemas/AdminAddExchangeInboundItems" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts index e8c4a89302..1ac9ca5eac 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -41,7 +41,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostExchangesShippingActionReqSchema" + * $ref: "#/components/schemas/AdminExchangeUpdateInboundShipping" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts index 3e17451b93..74be327785 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts @@ -31,7 +31,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostExchangesAddItemsReqSchema" + * $ref: "#/components/schemas/AdminAddExchangeOutboundItems" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts index d44b417212..65d3b0b86d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -41,7 +41,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostExchangesItemsActionReqSchema" + * $ref: "#/components/schemas/AdminUpdateExchangeOutboundItem" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts index 362c4c8703..75a2774f50 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostExchangesShippingReqSchema" + * $ref: "#/components/schemas/AdminExchangeAddOutboundShipping" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts index 445db01ae4..832d60b9db 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -41,7 +41,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostExchangesShippingActionReqSchema" + * $ref: "#/components/schemas/AdminExchangeUpdateOutboundShipping" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts index 91d33580c8..1c9634c370 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateFulfillmentSetServiceZones" + * $ref: "#/components/schemas/AdminCreateFulfillmentSetServiceZone" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 27d2a8a0c4..6cd188a3ae 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -38,7 +38,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUpdateFulfillmentSetServiceZones" + * $ref: "#/components/schemas/AdminUpdateFulfillmentSetServiceZone" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts index c5a1e02f51..8dc3a9c8f8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateShipment" + * $ref: "#/components/schemas/AdminCreateFulfillmentShipment" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_index_sync.ts b/www/utils/generated/oas-output/operations/admin/post_admin_index_sync.ts new file mode 100644 index 0000000000..27ea221392 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_index_sync.ts @@ -0,0 +1,48 @@ +/** + * @oas [post] /admin/index/sync + * operationId: PostIndexSync + * summary: Trigger Index Sync + * description: Trigger reindexing or re-ingestion of the Index Module. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminIndexSyncPayload" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/index/sync' \ + * -H 'Authorization: Bearer {access_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "strategy": "full" + * }' + * tags: + * - Index + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-since: 2.11.2 + * x-featureFlag: index + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts index e3e61f2237..85979a283b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateInventoryLocationLevel" + * $ref: "#/components/schemas/AdminBatchCreateInventoryItemLocationLevels" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts index d55091d219..9a21da1d74 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -38,7 +38,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUpdateInventoryLocationLevel" + * $ref: "#/components/schemas/AdminUpdateInventoryLevel" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts index 897e727b05..88f7dd2dd3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts @@ -25,6 +25,14 @@ * fields. Without prefix it will replace the entire default fields. * externalDocs: * url: "#select-fields-and-relations" + * - name: version + * in: query + * description: The version of the order to retrieve. + * required: false + * schema: + * type: number + * title: version + * description: The version of the order to retrieve. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_credit-lines.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_credit-lines.ts index 9c11bf3855..d225a1a154 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_credit-lines.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_credit-lines.ts @@ -34,7 +34,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateOrderCreditLines" + * $ref: "#/components/schemas/AdminCreateOrderCreditLine" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts index cd5c618677..b2b91a5feb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts @@ -17,18 +17,6 @@ * required: true * schema: * type: string - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. - * externalDocs: - * url: "#select-fields-and-relations" * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer.ts index 50cf47f045..f42c242a05 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer.ts @@ -35,7 +35,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminTransferOrder" + * $ref: "#/components/schemas/AdminRequestOrderTransfer" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts index 97b6d23340..35f89e79fe 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminMarkPaymentCollectionPaid" + * $ref: "#/components/schemas/AdminMarkPaymentCollectionAsPaid" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts index 2517194989..357247f703 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts @@ -31,7 +31,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreatePaymentCapture" + * $ref: "#/components/schemas/AdminCapturePayment" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts index 12e1ac7e69..8e826cd50f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts @@ -31,7 +31,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreatePaymentRefund" + * $ref: "#/components/schemas/AdminRefundPayment" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts index ea1dedec0e..0622213f26 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts @@ -17,6 +17,348 @@ * fields. without prefix it will replace the entire default fields. * externalDocs: * url: "#select-fields-and-relations" + * - name: q + * in: query + * description: Apply a search query to the price list's searchable properties. + * required: false + * schema: + * type: string + * title: q + * description: Apply a search query to the price list's searchable properties. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: Filter by a specific price list ID. + * - type: array + * description: Filter by multiple price list IDs. + * items: + * type: string + * title: id + * description: A price list ID. + * - name: starts_at + * in: query + * description: Filter by a price list's start date. + * required: false + * schema: + * type: object + * description: Filter by a price list's start 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: ends_at + * in: query + * description: Filter by a price list's end date. + * required: false + * schema: + * type: object + * description: Filter by a price list's end 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: status + * in: query + * description: Filter by price list statuses. + * required: false + * schema: + * type: array + * description: Filter by price list statuses. + * items: + * type: string + * description: A price list status. + * enum: + * - draft + * - active + * - name: rules_count + * in: query + * description: Filter by multiple price list rules count. + * required: false + * schema: + * type: array + * description: Filter by price list rules count. + * items: + * type: number + * title: rules_count + * description: A price list's rules count. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * externalDocs: + * url: "#pagination" + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * externalDocs: + * url: "#pagination" + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * externalDocs: + * url: "#pagination" + * - name: with_deleted + * in: query + * description: The price list's with deleted. + * required: false + * schema: + * type: boolean + * title: with_deleted + * description: The price list's with deleted. + * - 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: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts index 6ff9fa0d24..658948898d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts @@ -19,44 +19,28 @@ * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" - * - name: offset + * - name: include_ancestors_tree * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * externalDocs: - * url: "#pagination" - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * externalDocs: - * url: "#pagination" - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * externalDocs: - * url: "#pagination" - * - name: with_deleted - * in: query - * description: Whether to include deleted records in the result. + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. * required: false * schema: * type: boolean - * title: with_deleted - * description: Whether to include deleted records in the result. + * title: include_ancestors_tree + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * - name: include_descendants_tree + * in: query + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. + * required: false + * schema: + * type: boolean + * title: include_descendants_tree + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts index 799926b68b..ab2f41381f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts @@ -25,6 +25,28 @@ * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" + * - name: include_ancestors_tree + * in: query + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * required: false + * schema: + * type: boolean + * title: include_ancestors_tree + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * - name: include_descendants_tree + * in: query + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. + * required: false + * schema: + * type: boolean + * title: include_descendants_tree + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts index 3b6a5cb1dd..432f7147ee 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts @@ -26,6 +26,28 @@ * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" + * - name: include_ancestors_tree + * in: query + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * required: false + * schema: + * type: boolean + * title: include_ancestors_tree + * description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass + * `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`. + * - name: include_descendants_tree + * in: query + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. + * required: false + * schema: + * type: boolean + * title: include_descendants_tree + * description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either + * pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, + * `fields=category_children.id,category_children.name`. * security: * - api_token: [] * - cookie_auth: [] @@ -34,23 +56,7 @@ * content: * application/json: * schema: - * type: object - * description: The products to add or remove from the category. - * properties: - * add: - * type: array - * description: The products to add. - * items: - * type: string - * title: add - * description: A product ID. - * remove: - * type: array - * description: The product to remove. - * items: - * type: string - * title: remove - * description: A product ID. + * $ref: "#/components/schemas/AdminBatchLink" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_images_[image_id]_variants_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_images_[image_id]_variants_batch.ts new file mode 100644 index 0000000000..4d39976849 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_images_[image_id]_variants_batch.ts @@ -0,0 +1,86 @@ +/** + * @oas [post] /admin/products/{id}/images/{image_id}/variants/batch + * operationId: PostProductsIdImagesImage_idVariantsBatch + * summary: Manage Variants of Product Image + * description: Manage the association between product variants and a product image. You can add or remove associations between variants and the image. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * - name: image_id + * in: path + * description: The product image's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminBatchImageVariantRequest" + * x-codeSamples: + * - lang: JavaScript + * label: JS SDK + * source: |- + * 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) + * }) + * - lang: Shell + * label: cURL + * source: |- + * 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"] + * }' + * tags: + * - Products + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminBatchImageVariantResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: batchImageVariantsWorkflow + * x-events: [] + * x-since: 2.11.2 + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_images_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_images_batch.ts new file mode 100644 index 0000000000..fc005862e1 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_images_batch.ts @@ -0,0 +1,86 @@ +/** + * @oas [post] /admin/products/{id}/variants/{variant_id}/images/batch + * operationId: PostProductsIdVariantsVariant_idImagesBatch + * summary: Manage Images of Product Variant + * description: Manage the association between product images and a product variant. You can add or remove associations between images and the variant. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * - name: variant_id + * in: path + * description: The product variant's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminBatchVariantImagesRequest" + * x-codeSamples: + * - lang: JavaScript + * label: JS SDK + * source: |- + * 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) + * }) + * - lang: Shell + * label: cURL + * source: |- + * 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"] + * }' + * tags: + * - Products + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminBatchVariantImagesResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: batchVariantImagesWorkflow + * x-events: [] + * x-since: 2.11.2 + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts index 3076debf82..c04c0b11ca 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts @@ -31,8 +31,8 @@ * description: The associations to create between a product variant and an inventory item. * required: * - variant_id - * - inventory_item_id * - required_quantity + * - inventory_item_id * properties: * required_quantity: * type: number @@ -55,8 +55,8 @@ * description: Update a product variant's association with an inventory item. * required: * - variant_id - * - inventory_item_id * - required_quantity + * - inventory_item_id * properties: * required_quantity: * type: number diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts index f58445e449..bd401f1162 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts @@ -23,6 +23,610 @@ * fields. without prefix it will replace the entire default fields. * externalDocs: * url: "#select-fields-and-relations" + * - name: tags + * in: query + * description: Filter products by their tags. + * required: false + * schema: + * type: object + * description: Filter products by their tags. + * properties: + * id: + * type: array + * description: Filter by tag IDs. + * items: + * type: string + * title: id + * description: A tag ID. + * - name: variants + * in: query + * description: Filter the products' variants. + * required: false + * schema: + * type: object + * description: Filter the products' variants. + * properties: + * options: + * type: object + * description: Filter the variants by their options. + * properties: + * value: + * type: string + * title: value + * description: The option's value. + * option_id: + * type: string + * title: option_id + * description: The option's ID. + * option: + * type: object + * description: The option's details. + * - name: title + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: title + * description: Filter products by their title. + * - type: array + * description: Filter products by multiple titles. + * items: + * type: string + * title: title + * description: A product title. + * - name: status + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: status + * description: Filter products by their status. + * enum: + * - draft + * - proposed + * - published + * - rejected + * - type: array + * description: Filter products by multiple statuses. + * items: + * type: string + * description: A product status. + * enum: + * - draft + * - proposed + * - published + * - rejected + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: Filter products by their ID. + * - type: array + * description: Filter products by multiple IDs. + * items: + * type: string + * title: id + * description: A product ID. + * - name: sales_channel_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: sales_channel_id + * description: Filter products by their sales channel ID. + * - type: array + * description: Filter products by multiple sales channel IDs. + * items: + * type: string + * title: sales_channel_id + * description: A sales channel ID. + * - name: created_at + * in: query + * description: Filter by a product's creation date. + * required: false + * schema: + * type: object + * description: Filter by a product'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 product's update date. + * required: false + * schema: + * type: object + * description: Filter by a product'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: handle + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: handle + * description: Filter products by their handle. + * - type: array + * description: Filter products by multiple handles. + * items: + * type: string + * title: handle + * description: A product handle. + * - name: is_giftcard + * in: query + * description: Filter products by whether they are gift cards. + * required: false + * schema: + * type: boolean + * title: is_giftcard + * description: Whether the product is a gift card. + * - name: collection_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: collection_id + * description: Filter products by their collection ID. + * - type: array + * description: Filter products by multiple collection IDs. + * items: + * type: string + * title: collection_id + * description: A collection ID. + * - name: type_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: type_id + * description: Filter products by their type ID. + * - type: array + * description: Filter products by multiple type IDs. + * items: + * type: string + * title: type_id + * description: The type ID's details. + * - name: deleted_at + * in: query + * description: Filter by a product's deletion date. + * required: false + * schema: + * type: object + * description: Filter by a product'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`). + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * externalDocs: + * url: "#pagination" + * - name: q + * in: query + * description: The product's q. + * required: false + * schema: + * type: string + * title: q + * description: The product's q. + * - name: category_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: category_id + * description: Filter products by their category ID. + * - type: array + * description: Filter products by their category IDs. + * items: + * type: string + * title: category_id + * description: A category ID. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * externalDocs: + * url: "#pagination" + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * externalDocs: + * url: "#pagination" + * - name: with_deleted + * in: query + * description: The product's with deleted. + * required: false + * schema: + * type: boolean + * title: with_deleted + * description: The product's with deleted. + * - name: $and + * in: query + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * required: false + * schema: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * - name: $or + * in: query + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * required: false + * schema: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * - name: price_list_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: price_list_id + * description: Filter products by the ID of a price list they belong to. + * - type: array + * description: Filter products by the IDs of price lists they belong to. + * items: + * type: string + * title: price_list_id + * description: A price list ID. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts index 99edd32448..9ea0da1a88 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts @@ -12,18 +12,37 @@ * required: true * schema: * type: string - * - name: fields + * - name: promotion_type * in: query - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. + * description: The promotion's type. * required: false * schema: * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. - * externalDocs: - * url: "#select-fields-and-relations" + * description: The promotion's type. + * enum: + * - standard + * - buyget + * - name: application_method_type + * in: query + * description: The promotion's application method type. + * required: false + * schema: + * type: string + * description: The promotion's application method type. + * enum: + * - fixed + * - percentage + * - name: application_method_target_type + * in: query + * description: The promotion's application method target type. + * required: false + * schema: + * type: string + * description: The promotion's application method target type. + * enum: + * - items + * - shipping_methods + * - order * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts index e882022120..787b435bd2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts @@ -12,18 +12,37 @@ * required: true * schema: * type: string - * - name: fields + * - name: promotion_type * in: query - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. + * description: The promotion's type. * required: false * schema: * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. - * externalDocs: - * url: "#select-fields-and-relations" + * description: The promotion's type. + * enum: + * - standard + * - buyget + * - name: application_method_type + * in: query + * description: The promotion's application method type. + * required: false + * schema: + * type: string + * description: The promotion's application method type. + * enum: + * - fixed + * - percentage + * - name: application_method_target_type + * in: query + * description: The promotion's application method target type. + * required: false + * schema: + * type: string + * description: The promotion's application method target type. + * enum: + * - items + * - shipping_methods + * - order * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts index 25c91ccca3..d038108ecc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts @@ -12,18 +12,37 @@ * required: true * schema: * type: string - * - name: fields + * - name: promotion_type * in: query - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. + * description: The promotion's type. * required: false * schema: * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. - * externalDocs: - * url: "#select-fields-and-relations" + * description: The promotion's type. + * enum: + * - standard + * - buyget + * - name: application_method_type + * in: query + * description: The promotion's application method type. + * required: false + * schema: + * type: string + * description: The promotion's application method type. + * enum: + * - fixed + * - percentage + * - name: application_method_target_type + * in: query + * description: The promotion's application method target type. + * required: false + * schema: + * type: string + * description: The promotion's application method target type. + * enum: + * - items + * - shipping_methods + * - order * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts index 0cf5c4020b..1f738c2fb8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts @@ -31,7 +31,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUpdatePaymentRefundReason" + * $ref: "#/components/schemas/AdminUpdateRefundReason" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts index ed6af39d52..a3a5e458e4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts @@ -25,7 +25,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReturnsReqSchema" + * $ref: "#/components/schemas/AdminInitiateReturnRequest" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts index b7ac17c7f4..a48230f467 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts @@ -31,7 +31,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReturnsReturnReqSchema" + * $ref: "#/components/schemas/AdminUpdateReturnRequest" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts index dda2cd7c38..48de2d1067 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReturnsReceiveItemsReqSchema" + * $ref: "#/components/schemas/AdminDismissItems" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts index 24ef2209b3..dca4a03771 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReturnsReceiveItemsReqSchema" + * $ref: "#/components/schemas/AdminReceiveItems" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts index ac81f62010..8b47f00324 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts @@ -31,7 +31,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReceiveReturnsReqSchema" + * $ref: "#/components/schemas/AdminInitiateReceiveReturn" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts index 1c8f2b483e..5b5687fece 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReturnsConfirmRequestReqSchema" + * $ref: "#/components/schemas/AdminConfirmReceiveReturn" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts index 01e5590974..f69763acb0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReturnsRequestItemsReqSchema" + * $ref: "#/components/schemas/AdminAddReturnItems" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts index 1e54d332fa..1c44b2be25 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts @@ -41,7 +41,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReturnsRequestItemsActionReqSchema" + * $ref: "#/components/schemas/AdminUpdateReturnItems" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts index 43d6034ae2..252c9ef97b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReturnsConfirmRequestReqSchema" + * $ref: "#/components/schemas/AdminConfirmReturnRequest" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts index 9f97a014d1..084ed29e29 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts @@ -32,7 +32,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReturnsShippingReqSchema" + * $ref: "#/components/schemas/AdminAddReturnShipping" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts index e9adae59b9..0f696c61f3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts @@ -41,7 +41,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostReturnsShippingActionReqSchema" + * $ref: "#/components/schemas/AdminUpdateReturnShipping" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts index 5c10fa2358..5e8e824d94 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts @@ -32,23 +32,7 @@ * content: * application/json: * schema: - * type: object - * description: The products to add or remove from the channel. - * properties: - * add: - * type: array - * description: The products to add to the sales channel. - * items: - * type: string - * title: add - * description: A product's ID. - * remove: - * type: array - * description: The products to remove from the sales channel. - * items: - * type: string - * title: remove - * description: A product's ID. + * $ref: "#/components/schemas/AdminBatchLink" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts index 9e2863ca2d..842389069d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts @@ -31,7 +31,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUpdateShippingOptionType" + * $ref: "#/components/schemas/AdminUpdateShippingOption" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts index 8b2258692e..71d5ddced9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts @@ -32,23 +32,7 @@ * content: * application/json: * schema: - * type: object - * description: The fulfillment providers to add or remove from the stock location. - * properties: - * add: - * type: array - * description: The fulfillment providers to add to the stock location. - * items: - * type: string - * title: add - * description: A fulfillment provider's ID. - * remove: - * type: array - * description: The fulfillment providers to remove from the stock location. - * items: - * type: string - * title: remove - * description: A fulfillment provider's ID. + * $ref: "#/components/schemas/AdminBatchLink" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts index d55f3e39aa..2ec39635d1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts @@ -32,23 +32,7 @@ * content: * application/json: * schema: - * type: object - * description: The sales channels to add or remove. - * properties: - * add: - * type: array - * description: The sales channels to add. - * items: - * type: string - * title: add - * description: A sales channel's ID. - * remove: - * type: array - * description: The sales channels to remove. - * items: - * type: string - * title: remove - * description: A sales channel's ID. + * $ref: "#/components/schemas/AdminBatchLink" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts index 45dd7adcd4..8b62755c8c 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts @@ -17,48 +17,6 @@ * type: string * externalDocs: * url: https://docs.medusajs.com/api/store#publishable-api-key - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom - * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom - * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. - * externalDocs: - * url: "#select-fields-and-relations" - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * externalDocs: - * url: "#pagination" - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * externalDocs: - * url: "#pagination" - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: city * in: query * description: Filter by the address's city. @@ -112,14 +70,54 @@ * type: string * title: q * description: Search term to filter the address's searchable properties. - * - name: with_deleted + * - name: company * in: query - * description: Whether to include deleted records in the result. * required: false * schema: - * type: boolean - * title: with_deleted - * description: Whether to include deleted records in the result. + * oneOf: + * - type: string + * title: company + * description: Filter addresses by company. + * - type: array + * description: Filter addresses by companies. + * items: + * type: string + * title: company + * description: A company. + * - name: province + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: province + * description: Filter addresses by province. + * - type: array + * description: Filter addresses by provinces. + * items: + * type: string + * title: province + * description: A province. + * - 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: * - cookie_auth: [] * - jwt_token: [] diff --git a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts index 4275ed26ee..d524fdbb1d 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts @@ -73,36 +73,6 @@ * type: string * title: cart_id * description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * externalDocs: - * url: "#pagination" - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * externalDocs: - * url: "#pagination" - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * externalDocs: - * url: "#pagination" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_decline.ts b/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_decline.ts index 148f83faea..59e679935a 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_decline.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_decline.ts @@ -38,7 +38,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/StoreDeclineOrderTransferRequest" + * $ref: "#/components/schemas/StoreDeclineOrderTransfer" * x-codeSamples: * - lang: JavaScript * label: JS SDK diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminAddClaimItems.ts similarity index 92% rename from www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminAddClaimItems.ts index 8864a0e345..86081c89b6 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminAddClaimItems.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostClaimItemsReqSchema + * @schema AdminAddClaimItems * type: object * description: The details of the order items to add to the claim. - * x-schemaName: AdminPostClaimItemsReqSchema + * x-schemaName: AdminAddClaimItems * properties: * items: * type: array diff --git a/www/utils/generated/oas-output/schemas/AdminAddClaimOutboundItems.ts b/www/utils/generated/oas-output/schemas/AdminAddClaimOutboundItems.ts new file mode 100644 index 0000000000..cdba27ab5f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminAddClaimOutboundItems.ts @@ -0,0 +1,43 @@ +/** + * @schema AdminAddClaimOutboundItems + * 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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminAddExchangeInboundItems.ts similarity index 92% rename from www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminAddExchangeInboundItems.ts index 6014ed5447..163cd4fdc5 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminAddExchangeInboundItems.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostExchangesReturnRequestItemsReqSchema + * @schema AdminAddExchangeInboundItems * type: object * description: The details of the inbound (return) items. - * x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema + * x-schemaName: AdminAddExchangeInboundItems * properties: * items: * type: array diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminAddExchangeOutboundItems.ts similarity index 93% rename from www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminAddExchangeOutboundItems.ts index 53a85f623a..7c3b2f32c1 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminAddExchangeOutboundItems.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostExchangesAddItemsReqSchema + * @schema AdminAddExchangeOutboundItems * type: object * description: The details of outbound items. - * x-schemaName: AdminPostExchangesAddItemsReqSchema + * x-schemaName: AdminAddExchangeOutboundItems * properties: * items: * type: array diff --git a/www/utils/generated/oas-output/schemas/AdminAddReturnItem.ts b/www/utils/generated/oas-output/schemas/AdminAddReturnItem.ts new file mode 100644 index 0000000000..703f0461fb --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminAddReturnItem.ts @@ -0,0 +1,34 @@ +/** + * @schema AdminAddReturnItem + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminAddReturnItems.ts b/www/utils/generated/oas-output/schemas/AdminAddReturnItems.ts new file mode 100644 index 0000000000..acc7f5079d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminAddReturnItems.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminAddReturnItems + * type: object + * description: The items' details. + * x-schemaName: AdminAddReturnItems + * properties: + * items: + * type: array + * description: The items' details. + * items: + * $ref: "#/components/schemas/AdminAddReturnItem" + * required: + * - items + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminAddReturnShipping.ts b/www/utils/generated/oas-output/schemas/AdminAddReturnShipping.ts new file mode 100644 index 0000000000..8835283164 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminAddReturnShipping.ts @@ -0,0 +1,33 @@ +/** + * @schema AdminAddReturnShipping + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateInventoryLocationLevel.ts b/www/utils/generated/oas-output/schemas/AdminBatchCreateInventoryItemLocationLevels.ts similarity index 81% rename from www/utils/generated/oas-output/schemas/AdminCreateInventoryLocationLevel.ts rename to www/utils/generated/oas-output/schemas/AdminBatchCreateInventoryItemLocationLevels.ts index 8a8b865982..48cd5e8bbe 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateInventoryLocationLevel.ts +++ b/www/utils/generated/oas-output/schemas/AdminBatchCreateInventoryItemLocationLevels.ts @@ -1,5 +1,5 @@ /** - * @schema AdminCreateInventoryLocationLevel + * @schema AdminBatchCreateInventoryItemLocationLevels * type: object * description: The inventory level's details. * required: @@ -17,7 +17,7 @@ * type: number * title: incoming_quantity * description: The inventory level's incoming quantity. - * x-schemaName: AdminCreateInventoryLocationLevel + * x-schemaName: AdminBatchCreateInventoryItemLocationLevels * */ diff --git a/www/utils/generated/oas-output/schemas/AdminBatchImageVariantRequest.ts b/www/utils/generated/oas-output/schemas/AdminBatchImageVariantRequest.ts new file mode 100644 index 0000000000..33da903750 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminBatchImageVariantRequest.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminBatchImageVariantRequest + * 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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminBatchImageVariantResponse.ts b/www/utils/generated/oas-output/schemas/AdminBatchImageVariantResponse.ts new file mode 100644 index 0000000000..f1852f2a16 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminBatchImageVariantResponse.ts @@ -0,0 +1,26 @@ +/** + * @schema AdminBatchImageVariantResponse + * 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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminBatchLink.ts b/www/utils/generated/oas-output/schemas/AdminBatchLink.ts new file mode 100644 index 0000000000..885b749112 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminBatchLink.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminBatchLink + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts b/www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts index 31bccbb37b..13b1caec95 100644 --- a/www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts @@ -37,6 +37,10 @@ * type: string * title: url * description: The image's URL. + * id: + * type: string + * title: id + * description: The image's ID. * thumbnail: * type: string * title: thumbnail diff --git a/www/utils/generated/oas-output/schemas/AdminBatchUpdateProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminBatchUpdateProductVariant.ts index f9defaf53f..97625b7dd8 100644 --- a/www/utils/generated/oas-output/schemas/AdminBatchUpdateProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminBatchUpdateProductVariant.ts @@ -86,6 +86,10 @@ * type: string * title: id * description: The update's ID. + * thumbnail: + * type: string + * title: thumbnail + * description: The variant's thumbnail. * required: * - id * diff --git a/www/utils/generated/oas-output/schemas/AdminBatchVariantImagesRequest.ts b/www/utils/generated/oas-output/schemas/AdminBatchVariantImagesRequest.ts new file mode 100644 index 0000000000..0d9a869d0c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminBatchVariantImagesRequest.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminBatchVariantImagesRequest + * 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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminBatchVariantImagesResponse.ts b/www/utils/generated/oas-output/schemas/AdminBatchVariantImagesResponse.ts new file mode 100644 index 0000000000..afc50e4ec0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminBatchVariantImagesResponse.ts @@ -0,0 +1,26 @@ +/** + * @schema AdminBatchVariantImagesResponse + * 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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreatePaymentCapture.ts b/www/utils/generated/oas-output/schemas/AdminCapturePayment.ts similarity index 69% rename from www/utils/generated/oas-output/schemas/AdminCreatePaymentCapture.ts rename to www/utils/generated/oas-output/schemas/AdminCapturePayment.ts index 52fd075e71..bd68bfe6e5 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreatePaymentCapture.ts +++ b/www/utils/generated/oas-output/schemas/AdminCapturePayment.ts @@ -1,5 +1,5 @@ /** - * @schema AdminCreatePaymentCapture + * @schema AdminCapturePayment * type: object * description: The payment's details. * properties: @@ -7,7 +7,7 @@ * type: number * title: amount * description: The amount to capture. - * x-schemaName: AdminCreatePaymentCapture + * x-schemaName: AdminCapturePayment * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminClaimAddOutboundShipping.ts similarity index 90% rename from www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminClaimAddOutboundShipping.ts index d5cb4f18cf..7c3529a67f 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimAddOutboundShipping.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostClaimsShippingReqSchema + * @schema AdminClaimAddOutboundShipping * 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: diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminClaimUpdateInboundShipping.ts similarity index 85% rename from www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminClaimUpdateInboundShipping.ts index 7194a0f494..aa8cbe46c7 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimUpdateInboundShipping.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostClaimsShippingActionReqSchema + * @schema AdminClaimUpdateInboundShipping * type: object * description: The details to update in the shipping method. - * x-schemaName: AdminPostClaimsShippingActionReqSchema + * x-schemaName: AdminClaimUpdateInboundShipping * properties: * custom_amount: * type: number diff --git a/www/utils/generated/oas-output/schemas/AdminClaimUpdateOutboundShipping.ts b/www/utils/generated/oas-output/schemas/AdminClaimUpdateOutboundShipping.ts new file mode 100644 index 0000000000..c094b22c68 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminClaimUpdateOutboundShipping.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminClaimUpdateOutboundShipping + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsConfirmRequestReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminConfirmReceiveReturn.ts similarity index 69% rename from www/utils/generated/oas-output/schemas/AdminPostReturnsConfirmRequestReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminConfirmReceiveReturn.ts index 7584038ff0..6c0a390cc5 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsConfirmRequestReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminConfirmReceiveReturn.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostReturnsConfirmRequestReqSchema + * @schema AdminConfirmReceiveReturn * type: object * description: The confirmation's details. - * x-schemaName: AdminPostReturnsConfirmRequestReqSchema + * x-schemaName: AdminConfirmReceiveReturn * properties: * no_notification: * type: boolean diff --git a/www/utils/generated/oas-output/schemas/AdminConfirmReturnRequest.ts b/www/utils/generated/oas-output/schemas/AdminConfirmReturnRequest.ts new file mode 100644 index 0000000000..789056e81d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminConfirmReturnRequest.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminConfirmReturnRequest + * 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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminCreateClaim.ts similarity index 91% rename from www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminCreateClaim.ts index 35b43c9287..2753202f86 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateClaim.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostOrderClaimsReqSchema + * @schema AdminCreateClaim * type: object * description: The claim's details. - * x-schemaName: AdminPostOrderClaimsReqSchema + * x-schemaName: AdminCreateClaim * required: * - type * - order_id diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminCreateExchange.ts similarity index 88% rename from www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminCreateExchange.ts index 4b1b7400e7..db444e56b6 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateExchange.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostOrderExchangesReqSchema + * @schema AdminCreateExchange * type: object * description: The exchange's details. - * x-schemaName: AdminPostOrderExchangesReqSchema + * x-schemaName: AdminCreateExchange * required: * - order_id * properties: diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts index 36643400db..479330181e 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts @@ -4,14 +4,12 @@ * 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 @@ -22,118 +20,17 @@ * 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: "#/components/schemas/AdminFulfillmentDeliveryAddress" * 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: "#/components/schemas/AdminCreateFulfillmentItem" * 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: "#/components/schemas/AdminCreateFulfillmentLabel" * order_id: * type: string * title: order_id diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentItem.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentItem.ts new file mode 100644 index 0000000000..70010752a2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentItem.ts @@ -0,0 +1,38 @@ +/** + * @schema AdminCreateFulfillmentItem + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentLabel.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentLabel.ts new file mode 100644 index 0000000000..8d1808ff1f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentLabel.ts @@ -0,0 +1,25 @@ +/** + * @schema AdminCreateFulfillmentLabel + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZones.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZone.ts similarity index 96% rename from www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZones.ts rename to www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZone.ts index afc094619e..0ed328e9d9 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZones.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZone.ts @@ -1,9 +1,10 @@ /** - * @schema AdminCreateFulfillmentSetServiceZones + * @schema AdminCreateFulfillmentSetServiceZone * 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 @@ -143,7 +144,7 @@ * postal_expression: * type: object * description: The geo zone's postal expression or ZIP code. - * x-schemaName: AdminCreateFulfillmentSetServiceZones + * x-schemaName: AdminCreateFulfillmentSetServiceZone * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentShipment.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentShipment.ts new file mode 100644 index 0000000000..b10b9cc02c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentShipment.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminCreateFulfillmentShipment + * 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: "#/components/schemas/AdminCreateFulfillmentLabel" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLines.ts b/www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLine.ts similarity index 91% rename from www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLines.ts rename to www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLine.ts index 0c5b2d6e77..3966c23847 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLines.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLine.ts @@ -1,8 +1,8 @@ /** - * @schema AdminCreateOrderCreditLines + * @schema AdminCreateOrderCreditLine * type: object * description: The details of a credit line to add to an order. - * x-schemaName: AdminCreateOrderCreditLines + * x-schemaName: AdminCreateOrderCreditLine * required: * - amount * - reference diff --git a/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts b/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts index 51e8a05b83..f7f8c2a776 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts @@ -46,38 +46,7 @@ * 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: "#/components/schemas/AdminCreatePriceListPrice" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreatePriceListPrice.ts b/www/utils/generated/oas-output/schemas/AdminCreatePriceListPrice.ts new file mode 100644 index 0000000000..22e214aa6b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreatePriceListPrice.ts @@ -0,0 +1,38 @@ +/** + * @schema AdminCreatePriceListPrice + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShipment.ts b/www/utils/generated/oas-output/schemas/AdminCreateShipment.ts deleted file mode 100644 index 95d3c3a717..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCreateShipment.ts +++ /dev/null @@ -1,34 +0,0 @@ -/** - * @schema AdminCreateShipment - * 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. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminCreateStockLocationFulfillmentSet.ts b/www/utils/generated/oas-output/schemas/AdminCreateStockLocationFulfillmentSet.ts index 3f9c1a81df..04f5fa21bd 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateStockLocationFulfillmentSet.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateStockLocationFulfillmentSet.ts @@ -3,8 +3,8 @@ * type: object * description: The fulfillment set to create. * required: - * - type * - name + * - type * properties: * name: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts index 6b6ff947a2..492005c32a 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts @@ -4,8 +4,8 @@ * 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 diff --git a/www/utils/generated/oas-output/schemas/AdminDismissItems.ts b/www/utils/generated/oas-output/schemas/AdminDismissItems.ts new file mode 100644 index 0000000000..2fcb4e3a27 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminDismissItems.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminDismissItems + * 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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts b/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts index 903db86a0d..1e94c3734d 100644 --- a/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts @@ -8,13 +8,13 @@ * - items * - shipping_methods * - status - * - currency_code * - id * - version * - region_id * - customer_id * - sales_channel_id * - email + * - currency_code * - payment_status * - fulfillment_status * - summary diff --git a/www/utils/generated/oas-output/schemas/AdminDraftOrderParams.ts b/www/utils/generated/oas-output/schemas/AdminDraftOrderParams.ts new file mode 100644 index 0000000000..fd0291a5a2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminDraftOrderParams.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminDraftOrderParams + * 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. +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts index f65aa07ae5..643a203f1e 100644 --- a/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts @@ -7,13 +7,13 @@ * - 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 diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminExchangeAddOutboundShipping.ts similarity index 90% rename from www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminExchangeAddOutboundShipping.ts index 1841099bee..446ae7a40f 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangeAddOutboundShipping.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostExchangesShippingReqSchema + * @schema AdminExchangeAddOutboundShipping * type: object * description: The outbound shipping method's details. - * x-schemaName: AdminPostExchangesShippingReqSchema + * x-schemaName: AdminExchangeAddOutboundShipping * required: * - shipping_option_id * properties: diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminExchangeUpdateInboundShipping.ts similarity index 84% rename from www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminExchangeUpdateInboundShipping.ts index 17a125d64d..adff9989e1 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangeUpdateInboundShipping.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostExchangesShippingActionReqSchema + * @schema AdminExchangeUpdateInboundShipping * type: object * description: The details of the shipping method to update. - * x-schemaName: AdminPostExchangesShippingActionReqSchema + * x-schemaName: AdminExchangeUpdateInboundShipping * properties: * custom_amount: * type: number diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeUpdateOutboundShipping.ts b/www/utils/generated/oas-output/schemas/AdminExchangeUpdateOutboundShipping.ts new file mode 100644 index 0000000000..785b02b57a --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminExchangeUpdateOutboundShipping.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminExchangeUpdateOutboundShipping + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentDeliveryAddress.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentDeliveryAddress.ts new file mode 100644 index 0000000000..06de3a7664 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentDeliveryAddress.ts @@ -0,0 +1,59 @@ +/** + * @schema AdminFulfillmentDeliveryAddress + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminIndexDetailsResponse.ts b/www/utils/generated/oas-output/schemas/AdminIndexDetailsResponse.ts new file mode 100644 index 0000000000..7d634f8792 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminIndexDetailsResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminIndexDetailsResponse + * type: object + * description: The index's metadata details. + * x-schemaName: AdminIndexDetailsResponse + * required: + * - metadata + * properties: + * metadata: + * type: array + * description: The index's metadata. + * items: + * $ref: "#/components/schemas/IndexInfo" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminIndexSyncPayload.ts b/www/utils/generated/oas-output/schemas/AdminIndexSyncPayload.ts new file mode 100644 index 0000000000..10a149fa3b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminIndexSyncPayload.ts @@ -0,0 +1,17 @@ +/** + * @schema AdminIndexSyncPayload + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminInitiateReceiveReturn.ts similarity index 85% rename from www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminInitiateReceiveReturn.ts index 1197a4cc07..0723c55030 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminInitiateReceiveReturn.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostReceiveReturnsReqSchema + * @schema AdminInitiateReceiveReturn * type: object * description: The return receival details. - * x-schemaName: AdminPostReceiveReturnsReqSchema + * x-schemaName: AdminInitiateReceiveReturn * properties: * internal_note: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminInitiateReturnRequest.ts similarity index 92% rename from www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminInitiateReturnRequest.ts index e5b3c42bbf..7c1e7ffcfc 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminInitiateReturnRequest.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostReturnsReqSchema + * @schema AdminInitiateReturnRequest * type: object * description: The return's details. - * x-schemaName: AdminPostReturnsReqSchema + * x-schemaName: AdminInitiateReturnRequest * required: * - order_id * properties: diff --git a/www/utils/generated/oas-output/schemas/AdminMarkPaymentCollectionPaid.ts b/www/utils/generated/oas-output/schemas/AdminMarkPaymentCollectionAsPaid.ts similarity index 72% rename from www/utils/generated/oas-output/schemas/AdminMarkPaymentCollectionPaid.ts rename to www/utils/generated/oas-output/schemas/AdminMarkPaymentCollectionAsPaid.ts index d3f65aee26..b8c5d8b861 100644 --- a/www/utils/generated/oas-output/schemas/AdminMarkPaymentCollectionPaid.ts +++ b/www/utils/generated/oas-output/schemas/AdminMarkPaymentCollectionAsPaid.ts @@ -1,5 +1,5 @@ /** - * @schema AdminMarkPaymentCollectionPaid + * @schema AdminMarkPaymentCollectionAsPaid * type: object * description: The payment details. * required: @@ -9,7 +9,7 @@ * type: string * title: order_id * description: The ID of the order associated with the payment collection. - * x-schemaName: AdminMarkPaymentCollectionPaid + * x-schemaName: AdminMarkPaymentCollectionAsPaid * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrder.ts b/www/utils/generated/oas-output/schemas/AdminOrder.ts index f5c609d584..9d5a138bd5 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrder.ts @@ -8,13 +8,13 @@ * - items * - shipping_methods * - status - * - currency_code * - id * - version * - region_id * - customer_id * - sales_channel_id * - email + * - currency_code * - payment_status * - fulfillment_status * - summary diff --git a/www/utils/generated/oas-output/schemas/AdminOrderChange.ts b/www/utils/generated/oas-output/schemas/AdminOrderChange.ts index 1c65cd3a17..3edcf092b2 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderChange.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderChange.ts @@ -16,7 +16,6 @@ * - created_at * - updated_at * - order_id - * - canceled_at * - return_id * - exchange_id * - claim_id @@ -28,6 +27,7 @@ * - declined_reason * - declined_at * - canceled_by + * - canceled_at * properties: * id: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts index 739be5d91f..0829953531 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts @@ -7,13 +7,13 @@ * - 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 diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts deleted file mode 100644 index 2f8aedc88b..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts +++ /dev/null @@ -1,41 +0,0 @@ -/** - * @schema AdminPostClaimsAddItemsReqSchema - * 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 - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminProduct.ts b/www/utils/generated/oas-output/schemas/AdminProduct.ts index 87e7913bed..d1c4ae519a 100644 --- a/www/utils/generated/oas-output/schemas/AdminProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminProduct.ts @@ -11,13 +11,13 @@ * - length * - title * - status - * - description * - id * - created_at * - updated_at * - subtitle * - thumbnail * - handle + * - description * - is_giftcard * - width * - weight diff --git a/www/utils/generated/oas-output/schemas/AdminProductImage.ts b/www/utils/generated/oas-output/schemas/AdminProductImage.ts index f6509f9df3..c332819914 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductImage.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductImage.ts @@ -37,6 +37,13 @@ * type: number * title: rank * description: The image's rank among sibling images. + * product: + * $ref: "#/components/schemas/AdminProduct" + * variants: + * type: array + * description: The variants associated with the image. + * items: + * $ref: "#/components/schemas/AdminProductVariant" * required: * - id * - url diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts index c994a59046..23df19ae7b 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts @@ -12,6 +12,7 @@ * - barcode * - ean * - upc + * - thumbnail * - allow_backorder * - manage_inventory * - hs_code @@ -142,6 +143,15 @@ * description: The variant's inventory items. * items: * $ref: "#/components/schemas/AdminProductVariantInventoryItemLink" + * images: + * type: array + * description: The variant's images. + * items: + * $ref: "#/components/schemas/AdminProductImage" + * thumbnail: + * type: string + * title: thumbnail + * description: The variant's thumbnail. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReceiveItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminReceiveItems.ts similarity index 88% rename from www/utils/generated/oas-output/schemas/AdminPostReturnsReceiveItemsReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminReceiveItems.ts index f824a7eb08..f579b96207 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsReceiveItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminReceiveItems.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostReturnsReceiveItemsReqSchema + * @schema AdminReceiveItems * type: object * description: The items details. - * x-schemaName: AdminPostReturnsReceiveItemsReqSchema + * x-schemaName: AdminReceiveItems * properties: * items: * type: array diff --git a/www/utils/generated/oas-output/schemas/AdminCreatePaymentRefund.ts b/www/utils/generated/oas-output/schemas/AdminRefundPayment.ts similarity index 83% rename from www/utils/generated/oas-output/schemas/AdminCreatePaymentRefund.ts rename to www/utils/generated/oas-output/schemas/AdminRefundPayment.ts index 4da6e5ce25..23516fc570 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreatePaymentRefund.ts +++ b/www/utils/generated/oas-output/schemas/AdminRefundPayment.ts @@ -1,5 +1,5 @@ /** - * @schema AdminCreatePaymentRefund + * @schema AdminRefundPayment * type: object * description: The refund's details. * properties: @@ -15,7 +15,7 @@ * type: string * title: note * description: A note to attach to the refund. - * x-schemaName: AdminCreatePaymentRefund + * x-schemaName: AdminRefundPayment * */ diff --git a/www/utils/generated/oas-output/schemas/AdminRegion.ts b/www/utils/generated/oas-output/schemas/AdminRegion.ts index 9e2f86362c..2de91ffe68 100644 --- a/www/utils/generated/oas-output/schemas/AdminRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminRegion.ts @@ -4,9 +4,9 @@ * description: The region's details. * x-schemaName: AdminRegion * required: - * - name - * - currency_code * - id + * - currency_code + * - name * properties: * id: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminTransferOrder.ts b/www/utils/generated/oas-output/schemas/AdminRequestOrderTransfer.ts similarity index 88% rename from www/utils/generated/oas-output/schemas/AdminTransferOrder.ts rename to www/utils/generated/oas-output/schemas/AdminRequestOrderTransfer.ts index 8289d7a8d3..0bf1b8c316 100644 --- a/www/utils/generated/oas-output/schemas/AdminTransferOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminRequestOrderTransfer.ts @@ -1,8 +1,8 @@ /** - * @schema AdminTransferOrder + * @schema AdminRequestOrderTransfer * type: object * description: The details of the request to transfer the order. - * x-schemaName: AdminTransferOrder + * x-schemaName: AdminRequestOrderTransfer * required: * - customer_id * properties: diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminUpdateClaimItem.ts similarity index 82% rename from www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminUpdateClaimItem.ts index 984e2d3dda..570fa662d5 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateClaimItem.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostClaimsItemsActionReqSchema + * @schema AdminUpdateClaimItem * type: object * description: The details to update in the item. - * x-schemaName: AdminPostClaimsItemsActionReqSchema + * x-schemaName: AdminUpdateClaimItem * properties: * quantity: * type: number diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateClaimOutboundItem.ts b/www/utils/generated/oas-output/schemas/AdminUpdateClaimOutboundItem.ts new file mode 100644 index 0000000000..f1d8826b1b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateClaimOutboundItem.ts @@ -0,0 +1,21 @@ +/** + * @schema AdminUpdateClaimOutboundItem + * 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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrder.ts b/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrder.ts index 6672006106..f55a7ab038 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrder.ts @@ -10,115 +10,9 @@ * 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: "#/components/schemas/OrderAddress" * 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: "#/components/schemas/OrderAddress" * metadata: * type: object * description: The draft order's metadata, can hold custom key-value pairs. diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminUpdateExchangeOutboundItem.ts similarity index 75% rename from www/utils/generated/oas-output/schemas/AdminPostExchangesItemsActionReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminUpdateExchangeOutboundItem.ts index bf9b9ce18b..3f8683609f 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesItemsActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateExchangeOutboundItem.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostExchangesItemsActionReqSchema + * @schema AdminUpdateExchangeOutboundItem * type: object * description: The details to update in an outbound item. - * x-schemaName: AdminPostExchangesItemsActionReqSchema + * x-schemaName: AdminUpdateExchangeOutboundItem * properties: * quantity: * type: number diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZones.ts b/www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZone.ts similarity index 98% rename from www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZones.ts rename to www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZone.ts index ccc607e144..709d5232fd 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZones.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZone.ts @@ -1,5 +1,5 @@ /** - * @schema AdminUpdateFulfillmentSetServiceZones + * @schema AdminUpdateFulfillmentSetServiceZone * type: object * description: The service zone's details. * properties: @@ -157,7 +157,7 @@ * type: string * title: id * description: The ID of an existing geo zone. - * x-schemaName: AdminUpdateFulfillmentSetServiceZones + * x-schemaName: AdminUpdateFulfillmentSetServiceZone * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateInventoryLocationLevel.ts b/www/utils/generated/oas-output/schemas/AdminUpdateInventoryLevel.ts similarity index 79% rename from www/utils/generated/oas-output/schemas/AdminUpdateInventoryLocationLevel.ts rename to www/utils/generated/oas-output/schemas/AdminUpdateInventoryLevel.ts index 7f055b0dc7..3e0d2915ad 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateInventoryLocationLevel.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateInventoryLevel.ts @@ -1,5 +1,5 @@ /** - * @schema AdminUpdateInventoryLocationLevel + * @schema AdminUpdateInventoryLevel * type: object * description: The properties to update in the inventory level. * properties: @@ -11,7 +11,7 @@ * type: number * title: incoming_quantity * description: The inventory level's incoming quantity. - * x-schemaName: AdminUpdateInventoryLocationLevel + * x-schemaName: AdminUpdateInventoryLevel * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts b/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts index 45a5c2529a..150fec9b89 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts @@ -10,115 +10,9 @@ * 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: "#/components/schemas/OrderAddress" * 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: "#/components/schemas/OrderAddress" * metadata: * type: object * description: The order's metadata, can hold custom key-value pairs. diff --git a/www/utils/generated/oas-output/schemas/AdminUpdatePaymentRefundReason.ts b/www/utils/generated/oas-output/schemas/AdminUpdateRefundReason.ts similarity index 67% rename from www/utils/generated/oas-output/schemas/AdminUpdatePaymentRefundReason.ts rename to www/utils/generated/oas-output/schemas/AdminUpdateRefundReason.ts index 0187d96ffa..26d0bfec27 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdatePaymentRefundReason.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateRefundReason.ts @@ -1,5 +1,5 @@ /** - * @schema AdminUpdatePaymentRefundReason + * @schema AdminUpdateRefundReason * type: object * description: The properties to update in the refund reason. * properties: @@ -15,7 +15,13 @@ * 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 * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateReturnItems.ts b/www/utils/generated/oas-output/schemas/AdminUpdateReturnItems.ts new file mode 100644 index 0000000000..de3f10491e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateReturnItems.ts @@ -0,0 +1,27 @@ +/** + * @schema AdminUpdateReturnItems + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminUpdateReturnRequest.ts similarity index 87% rename from www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminUpdateReturnRequest.ts index 4705fbcbf2..804fc2edb4 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateReturnRequest.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostReturnsReturnReqSchema + * @schema AdminUpdateReturnRequest * type: object * description: The return's details. - * x-schemaName: AdminPostReturnsReturnReqSchema + * x-schemaName: AdminUpdateReturnRequest * properties: * location_id: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminUpdateReturnShipping.ts similarity index 84% rename from www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminUpdateReturnShipping.ts index e4a079c5b8..e10762e609 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateReturnShipping.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostReturnsShippingActionReqSchema + * @schema AdminUpdateReturnShipping * type: object * description: The shipping method's details. - * x-schemaName: AdminPostReturnsShippingActionReqSchema + * x-schemaName: AdminUpdateReturnShipping * properties: * custom_amount: * type: number diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateShippingOption.ts b/www/utils/generated/oas-output/schemas/AdminUpdateShippingOption.ts new file mode 100644 index 0000000000..48bde0bdd7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateShippingOption.ts @@ -0,0 +1,214 @@ +/** + * @schema AdminUpdateShippingOption + * 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: "#/components/schemas/AdminCreateShippingOptionType" + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts b/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts index 4b75edf630..bb1e5873ba 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts @@ -9,49 +9,7 @@ * 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: "#/components/schemas/AdminUpsertStockLocationAddress" * address_id: * type: string * title: address_id diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts b/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts index b86d38d11f..1f8d4f82ca 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts @@ -12,24 +12,7 @@ * 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: "#/components/schemas/AdminUpdateStoreSupportedCurrency" * default_sales_channel_id: * type: string * title: default_sales_channel_id diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateStoreSupportedCurrency.ts b/www/utils/generated/oas-output/schemas/AdminUpdateStoreSupportedCurrency.ts new file mode 100644 index 0000000000..f55b79230b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateStoreSupportedCurrency.ts @@ -0,0 +1,24 @@ +/** + * @schema AdminUpdateStoreSupportedCurrency + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts index a5d4df2784..03e7fef7f7 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts @@ -16,22 +16,7 @@ * 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: "#/components/schemas/AdminCreateTaxRateRule" * name: * type: string * title: name @@ -52,6 +37,8 @@ * externalDocs: * url: https://docs.medusajs.com/api/admin#manage-metadata * description: Learn how to manage metadata + * required: + * - code * */ diff --git a/www/utils/generated/oas-output/schemas/BaseProductVariant.ts b/www/utils/generated/oas-output/schemas/BaseProductVariant.ts index 8c9f4a3869..2f0cdc2f58 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductVariant.ts @@ -10,6 +10,7 @@ * - barcode * - ean * - upc + * - thumbnail * - allow_backorder * - manage_inventory * - hs_code @@ -131,6 +132,10 @@ * 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. * */ diff --git a/www/utils/generated/oas-output/schemas/IndexInfo.ts b/www/utils/generated/oas-output/schemas/IndexInfo.ts new file mode 100644 index 0000000000..41c30ed282 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/IndexInfo.ts @@ -0,0 +1,48 @@ +/** + * @schema IndexInfo + * 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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCart.ts b/www/utils/generated/oas-output/schemas/StoreCart.ts index 2d08620244..81a60bd461 100644 --- a/www/utils/generated/oas-output/schemas/StoreCart.ts +++ b/www/utils/generated/oas-output/schemas/StoreCart.ts @@ -5,8 +5,8 @@ * x-schemaName: StoreCart * required: * - promotions - * - currency_code * - id + * - currency_code * - original_item_total * - original_item_subtotal * - original_item_tax_total diff --git a/www/utils/generated/oas-output/schemas/StoreDeclineOrderTransferRequest.ts b/www/utils/generated/oas-output/schemas/StoreDeclineOrderTransfer.ts similarity index 74% rename from www/utils/generated/oas-output/schemas/StoreDeclineOrderTransferRequest.ts rename to www/utils/generated/oas-output/schemas/StoreDeclineOrderTransfer.ts index 47c756da6a..7154427f98 100644 --- a/www/utils/generated/oas-output/schemas/StoreDeclineOrderTransferRequest.ts +++ b/www/utils/generated/oas-output/schemas/StoreDeclineOrderTransfer.ts @@ -1,8 +1,8 @@ /** - * @schema StoreDeclineOrderTransferRequest + * @schema StoreDeclineOrderTransfer * type: object * description: The details of declining the order transfer request. - * x-schemaName: StoreDeclineOrderTransferRequest + * x-schemaName: StoreDeclineOrderTransfer * required: * - token * properties: diff --git a/www/utils/generated/oas-output/schemas/StoreOrder.ts b/www/utils/generated/oas-output/schemas/StoreOrder.ts index 7d492b23f8..a535b6f31f 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrder.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrder.ts @@ -7,12 +7,12 @@ * - items * - shipping_methods * - status - * - currency_code * - id * - region_id * - customer_id * - sales_channel_id * - email + * - currency_code * - payment_status * - fulfillment_status * - summary diff --git a/www/utils/generated/oas-output/schemas/StoreProductVariant.ts b/www/utils/generated/oas-output/schemas/StoreProductVariant.ts index 79d635ca4e..09d2d690e2 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductVariant.ts @@ -116,6 +116,10 @@ * description: The variant's rank among its siblings. * calculated_price: * $ref: "#/components/schemas/BaseCalculatedPriceSet" + * thumbnail: + * type: string + * title: thumbnail + * description: The variant's thumbnail. * required: * - options * - length @@ -123,6 +127,7 @@ * - id * - created_at * - updated_at + * - thumbnail * - width * - weight * - height @@ -131,12 +136,12 @@ * - mid_code * - material * - deleted_at - * - sku - * - barcode * - manage_inventory * - allow_backorder * - ean * - upc + * - barcode + * - sku * */ diff --git a/www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts b/www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts index 47907a3254..8e9ca4a606 100644 --- a/www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts +++ b/www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts @@ -103,7 +103,7 @@ * type: string * title: country_code * description: The address's country code. - * example: "us" + * example: us * province: * type: string * title: province diff --git a/www/utils/generated/route-examples-output/route-examples.json b/www/utils/generated/route-examples-output/route-examples.json index 17673f487f..9e4a5feba1 100644 --- a/www/utils/generated/route-examples-output/route-examples.json +++ b/www/utils/generated/route-examples-output/route-examples.json @@ -563,6 +563,12 @@ "DELETE /admin/products/{productid}/options/{id}": { "js-sdk": "sdk.admin.product.deleteOption(\"prod_123\", \"prodopt_123\")\n.then(({ deleted }) => {\n console.log(deleted)\n})" }, + "POST /admin/products/{productid}/images/{imageid}/variants/batch": { + "js-sdk": "sdk.admin.product.batchImageVariants(\"prod_123\", \"img_123\", {\n add: [\"variant_123\", \"variant_456\"],\n remove: [\"variant_789\"]\n})\n.then(({ added, removed }) => {\n console.log(added, removed)\n})" + }, + "POST /admin/products/{productid}/variants/{variantid}/images/batch": { + "js-sdk": "sdk.admin.product.batchVariantImages(\"prod_123\", \"variant_123\", {\n add: [\"img_123\", \"img_456\"],\n remove: [\"img_789\"]\n})\n.then(({ added, removed }) => {\n console.log(added, removed)\n})" + }, "POST /admin/product-categories": { "js-sdk": "sdk.admin.productCategory.create({\n name: \"Shirts\"\n})\n.then(({ product_category }) => {\n console.log(product_category)\n})" },